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.
60 lines
1.4 KiB
Plaintext
60 lines
1.4 KiB
Plaintext
include::../description.adoc[]
|
|
|
|
include::../ask-yourself.adoc[]
|
|
|
|
include::../recommended.adoc[]
|
|
|
|
== Sensitive Code Example
|
|
|
|
----
|
|
ip = "192.168.12.42"; // Sensitive
|
|
|
|
const net = require('net');
|
|
var client = new net.Socket();
|
|
client.connect(80, ip, function() {
|
|
// ...
|
|
});
|
|
----
|
|
|
|
== Compliant Solution
|
|
|
|
[source,javascript]
|
|
----
|
|
ip = process.env.IP_ADDRESS; // Compliant
|
|
|
|
const net = require('net');
|
|
var client = new net.Socket();
|
|
client.connect(80, ip, function() {
|
|
// ...
|
|
});
|
|
----
|
|
|
|
== Exceptions
|
|
|
|
No issue is reported for the following cases because they are not considered sensitive:
|
|
|
|
* Loopback addresses 127.0.0.0/8 in CIDR notation (from 127.0.0.0 to 127.255.255.255)
|
|
* Broadcast address 255.255.255.255
|
|
* Non routable address 0.0.0.0
|
|
* Strings of the form ``++2.5.<number>.<number>++`` as they http://www.oid-info.com/introduction.htm[often match Object Identifiers] (OID).
|
|
* Addresses in the ranges 192.0.2.0/24, 198.51.100.0/24, 203.0.113.0/24, reserved for documentation purposes by https://datatracker.ietf.org/doc/html/rfc5737[RFC 5737]
|
|
* Addresses in the 2001:db8::/32 range, reserved for documentation purposes by https://datatracker.ietf.org/doc/html/rfc3849[RFC 3849]
|
|
|
|
include::../see.adoc[]
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|