Sync javadoc.

righettod · Aug 27, 2024 · 11fd8d3 · 11fd8d3
1 parent 9e206f1
commit 11fd8d3
Show file tree

Hide file tree

Showing 17 changed files with 499 additions and 497 deletions.
diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>All Classes and Interfaces (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>All Packages (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/eu/righettod/InputFileType.html b/docs/eu/righettod/InputFileType.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>InputFileType (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/eu/righettod/ProcessingMode.html b/docs/eu/righettod/ProcessingMode.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>ProcessingMode (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/eu/righettod/SecurityUtils.html b/docs/eu/righettod/SecurityUtils.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>SecurityUtils (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
@@ -550,7 +550,7 @@ <h3>isPublicIPAddress</h3>
 <li>
 <section class="detail" id="computeHashNoProneToAbuseOnParts(java.util.List)">
 <h3>computeHashNoProneToAbuseOnParts</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-566">computeHashNoProneToAbuseOnParts</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;parts)</span>
+<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-567">computeHashNoProneToAbuseOnParts</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;parts)</span>
                                                throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div>
 <div class="block">Compute a SHA256 hash from an input composed of a collection of strings.<br><br>
  This method take care to build the source string in a way to prevent this source string to be prone to abuse targeting the different parts composing it.<br><br>
@@ -568,6 +568,7 @@ <h3>computeHashNoProneToAbuseOnParts</h3>
 <dt>See Also:</dt>
 <dd>
 <ul class="tag-list-long">
+<li>"https://github.com/righettod/code-snippets-security-utils/issues/16"</li>
 <li>"https://pentesterlab.com/badges/codereview"</li>
 <li>"https://blog.trailofbits.com/2024/08/21/yolo-is-not-a-valid-hash-construction/"</li>
 <li>"https://www.nist.gov/publications/sha-3-derived-functions-cshake-kmac-tuplehash-and-parallelhash"</li>
@@ -579,7 +580,7 @@ <h3>computeHashNoProneToAbuseOnParts</h3>
 <li>
 <section class="detail" id="isXMLOnlyUseAllowedXSDorDTD(java.lang.String,java.util.List)">
 <h3>isXMLOnlyUseAllowedXSDorDTD</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-603">isXMLOnlyUseAllowedXSDorDTD</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;xmlFilePath,
+<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-604">isXMLOnlyUseAllowedXSDorDTD</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;xmlFilePath,
  <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;allowedSystemIdentifiers)</span></div>
 <div class="block">Ensure that an XML file only uses DTD/XSD references (called System Identifier) present in the allowed list provided.<br><br>
  The code is based on the validation implemented into the OpenJDK 21, by the class <b><a href="https://github.com/openjdk/jdk/blob/jdk-21%2B35/src/java.prefs/share/classes/java/util/prefs/XmlSupport.java">java.util.prefs.XmlSupport</a></b>, in the method <b><a href="https://github.com/openjdk/jdk/blob/jdk-21%2B35/src/java.prefs/share/classes/java/util/prefs/XmlSupport.java#L240">loadPrefsDoc()</a></b>.<br><br>
@@ -607,7 +608,7 @@ <h3>isXMLOnlyUseAllowedXSDorDTD</h3>
 <li>
 <section class="detail" id="isExcelCSVSafe(java.lang.String)">
 <h3>isExcelCSVSafe</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-661">isExcelCSVSafe</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;csvFilePath)</span></div>
+<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-662">isExcelCSVSafe</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;csvFilePath)</span></div>
 <div class="block">Apply a collection of validations on a EXCEL CSV file provided (file was expected to be opened in Microsoft EXCEL):<br>
  - Real CSV file.<br>
  - Do not contains any payload related to a CSV injections.<br><br>
@@ -637,7 +638,7 @@ <h3>isExcelCSVSafe</h3>
 <li>
 <section class="detail" id="ensureSerializedObjectIntegrity(eu.righettod.ProcessingMode,java.lang.String,byte[])">
 <h3>ensureSerializedObjectIntegrity</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-705">ensureSerializedObjectIntegrity</a></span><wbr><span class="parameters">(<a href="ProcessingMode.html" title="enum class in eu.righettod">ProcessingMode</a>&nbsp;processingMode,
+<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-706">ensureSerializedObjectIntegrity</a></span><wbr><span class="parameters">(<a href="ProcessingMode.html" title="enum class in eu.righettod">ProcessingMode</a>&nbsp;processingMode,
  <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;input,
  byte[]&nbsp;secret)</span>
                                                           throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div>
@@ -671,7 +672,7 @@ <h3>ensureSerializedObjectIntegrity</h3>
 <li>
 <section class="detail" id="isJSONSafe(java.lang.String,int,int)">
 <h3>isJSONSafe</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-778">isJSONSafe</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;json,
+<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-779">isJSONSafe</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;json,
  int&nbsp;maxItemsByArraysCount,
  int&nbsp;maxDeepnessAllowed)</span></div>
 <div class="block">Apply a collection of validations on a JSON string provided:<br>
@@ -710,7 +711,7 @@ <h3>isJSONSafe</h3>
 <li>
 <section class="detail" id="isImageSafe(java.lang.String,java.util.List)">
 <h3>isImageSafe</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-887">isImageSafe</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;imageFilePath,
+<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-888">isImageSafe</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;imageFilePath,
  <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&gt;&nbsp;imageAllowedMimeTypes)</span></div>
 <div class="block">Apply a collection of validations on a image file provided:<br>
  - Real image file.<br>
@@ -748,7 +749,7 @@ <h3>isImageSafe</h3>
 <li>
 <section class="detail" id="sanitizeFile(java.lang.String,eu.righettod.InputFileType)">
 <h3>sanitizeFile</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-935">sanitizeFile</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;inputFilePath,
+<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">byte[]</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-936">sanitizeFile</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;inputFilePath,
  <a href="InputFileType.html" title="enum class in eu.righettod">InputFileType</a>&nbsp;inputFileType)</span>
                            throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div>
 <div class="block">Rewrite the input file to remove any embedded files that is not embedded using a methods supported by the official format of the file.<br>
@@ -777,7 +778,7 @@ <h3>sanitizeFile</h3>
 <li>
 <section class="detail" id="isEmailAddress(java.lang.String)">
 <h3>isEmailAddress</h3>
-<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-1004">isEmailAddress</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;addr)</span></div>
+<div class="member-signature"><span class="modifiers">public static</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../src-html/eu/righettod/SecurityUtils.html#line-1005">isEmailAddress</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;addr)</span></div>
 <div class="block">Apply a collection of validations on a string expected to be an email address:<br>
  - Is a valid email address, from a parser perspective, following RFCs on email addresses.<br>
  - Is not using "Encoded-word" format.<br>

diff --git a/docs/eu/righettod/class-use/InputFileType.html b/docs/eu/righettod/class-use/InputFileType.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>Uses of Enum Class eu.righettod.InputFileType (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/eu/righettod/class-use/ProcessingMode.html b/docs/eu/righettod/class-use/ProcessingMode.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>Uses of Enum Class eu.righettod.ProcessingMode (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/eu/righettod/class-use/SecurityUtils.html b/docs/eu/righettod/class-use/SecurityUtils.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>Uses of Class eu.righettod.SecurityUtils (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/eu/righettod/package-summary.html b/docs/eu/righettod/package-summary.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>eu.righettod (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/eu/righettod/package-tree.html b/docs/eu/righettod/package-tree.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>eu.righettod Class Hierarchy (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/eu/righettod/package-use.html b/docs/eu/righettod/package-use.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>Uses of Package eu.righettod (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/help-doc.html b/docs/help-doc.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>API Help (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/index-all.html b/docs/index-all.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>Index (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/index.html b/docs/index.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>Javadoc</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/overview-tree.html b/docs/overview-tree.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>Class Hierarchy (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

diff --git a/docs/search.html b/docs/search.html
@@ -1,7 +1,7 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Tue Aug 27 05:27:24 UTC 2024 -->
+<!-- Generated by javadoc (21) on Tue Aug 27 05:37:11 UTC 2024 -->
 <title>Search (Javadoc)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">