51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
50 lines
1.1 KiB
Plaintext
50 lines
1.1 KiB
Plaintext
include::../description.adoc[]
|
|
|
|
include::../ask-yourself.adoc[]
|
|
|
|
include::../recommended.adoc[]
|
|
|
|
== Sensitive Code Example
|
|
|
|
[source,csharp]
|
|
----
|
|
var urlHttp = "http://example.com"; // Noncompliant
|
|
var urlFtp = "ftp://anonymous@example.com"; // Noncompliant
|
|
var urlTelnet = "telnet://anonymous@example.com"; // Noncompliant
|
|
----
|
|
|
|
[source,csharp]
|
|
----
|
|
using var smtp = new SmtpClient("host", 25); // Noncompliant, EnableSsl is not set
|
|
using var telnet = new MyTelnet.Client("host", port); // Noncompliant, rule raises Security Hotspot on any member containing "Telnet"
|
|
----
|
|
|
|
== Compliant Solution
|
|
|
|
[source,csharp]
|
|
----
|
|
var urlHttps = "https://example.com";
|
|
var urlSftp = "sftp://anonymous@example.com";
|
|
var urlSsh = "ssh://anonymous@example.com";
|
|
----
|
|
|
|
[source,csharp]
|
|
----
|
|
using var smtp = new SmtpClient("host", 25) { EnableSsl = true };
|
|
using var ssh = new MySsh.Client("host", port);
|
|
----
|
|
|
|
include::../exceptions.adoc[]
|
|
|
|
include::../see.adoc[]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|