Sync javadoc.

GHActionBot · GHActionBot · commit 03a4c106c71e · 2024-10-27T09:20:30.000Z
diff --git a/docs/allclasses-index.html b/docs/allclasses-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="class index">
 <meta name="generator" content="javadoc/AllClassesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/docs/allpackages-index.html b/docs/allpackages-index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="package index">
 <meta name="generator" content="javadoc/AllPackagesIndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/docs/eu/righettod/InputFileType.html b/docs/eu/righettod/InputFileType.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="declaration: package: eu.righettod, enum: InputFileType">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
diff --git a/docs/eu/righettod/ProcessingMode.html b/docs/eu/righettod/ProcessingMode.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="declaration: package: eu.righettod, enum: ProcessingMode">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
diff --git a/docs/eu/righettod/SecurityUtils.html b/docs/eu/righettod/SecurityUtils.html
diff --git a/docs/eu/righettod/class-use/InputFileType.html b/docs/eu/righettod/class-use/InputFileType.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="use: package: eu.righettod, enum: InputFileType">
 <meta name="generator" content="javadoc/ClassUseWriter">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
diff --git a/docs/eu/righettod/class-use/ProcessingMode.html b/docs/eu/righettod/class-use/ProcessingMode.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="use: package: eu.righettod, enum: ProcessingMode">
 <meta name="generator" content="javadoc/ClassUseWriter">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
diff --git a/docs/eu/righettod/class-use/SecurityUtils.html b/docs/eu/righettod/class-use/SecurityUtils.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="use: package: eu.righettod, class: SecurityUtils">
 <meta name="generator" content="javadoc/ClassUseWriter">
 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
diff --git a/docs/eu/righettod/package-summary.html b/docs/eu/righettod/package-summary.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="declaration: package: eu.righettod">
 <meta name="generator" content="javadoc/PackageWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
diff --git a/docs/eu/righettod/package-tree.html b/docs/eu/righettod/package-tree.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="tree: package: eu.righettod">
 <meta name="generator" content="javadoc/PackageTreeWriter">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
diff --git a/docs/eu/righettod/package-use.html b/docs/eu/righettod/package-use.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="use: package: eu.righettod">
 <meta name="generator" content="javadoc/PackageUseWriter">
 <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
diff --git a/docs/help-doc.html b/docs/help-doc.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="help">
 <meta name="generator" content="javadoc/HelpWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
diff --git a/docs/index-all.html b/docs/index-all.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="index">
 <meta name="generator" content="javadoc/IndexWriter">
 <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
@@ -67,9 +67,7 @@ <h2 class="title" id="I:C">C</h2>
 <dt><a href="eu/righettod/SecurityUtils.html#computeHashNoProneToAbuseOnParts(java.util.List)" class="member-name-link">computeHashNoProneToAbuseOnParts(List&lt;String&gt;)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
 <dd>
 <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>
- Example of possible abuse without precautions applied during the hash calculation logic:<br>
- Hash of <code>SHA256("Hello", "My", "World!!!")</div>
+ 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></div>
 </dd>
 </dl>
 <h2 class="title" id="I:E">E</h2>
@@ -104,44 +102,51 @@ <h2 class="title" id="I:I">I</h2>
 </dd>
 <dt><a href="eu/righettod/SecurityUtils.html#isEmailAddress(java.lang.String)" class="member-name-link">isEmailAddress(String)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
 <dd>
-<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>
- - Is not using comment format.<br>
- - Is not using "Punycode" format.<br>
- - Is not using UUCP style addresses.<br>
- - Is not using address literals.<br>
- - Is not using source routes.<br>
- - Is not using the "percent hack".<br><br>
+<div class="block">Apply a collection of validations on a string expected to be an email address:
+ 
+ Is a valid email address, from a parser perspective, following RFCs on email addresses.
+ Is not using "Encoded-word" format.
+ Is not using comment format.
+ Is not using "Punycode" format.
+ Is not using UUCP style addresses.
+ Is not using address literals.
+ Is not using source routes.
+ Is not using the "percent hack".
+ <br>
  This is based on the research work from <a href="https://portswigger.net/research/gareth-heyes">Gareth Heyes</a> added in references (Portswigger).<br><br>
 
  <b>Note:</b> The notion of valid, here, is to take from a secure usage of the data perspective.</div>
 </dd>
 <dt><a href="eu/righettod/SecurityUtils.html#isExcelCSVSafe(java.lang.String)" class="member-name-link">isExcelCSVSafe(String)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
 <dd>
-<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>
+<div class="block">Apply a collection of validations on a EXCEL CSV file provided (file was expected to be opened in Microsoft EXCEL):
+ 
+ Real CSV file.
+ Do not contains any payload related to a CSV injections.
+ 
  Ensure that, if Apache Commons CSV does not find any record then, the file will be considered as NOT safe (prevent potential bypasses).<br><br>
  <b>Note:</b> Record delimiter used is the <code>,</code> (comma) character.</div>
 </dd>
 <dt><a href="eu/righettod/SecurityUtils.html#isImageSafe(java.lang.String,java.util.List)" class="member-name-link">isImageSafe(String, List&lt;String&gt;)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
 <dd>
-<div class="block">Apply a collection of validations on a image file provided:<br>
- - Real image file.<br>
- - Its mime type is into the list of allowed mime types.<br>
- - Its metadata fields do not contains any characters related to a malicious payloads.<br>
-
+<div class="block">Apply a collection of validations on a image file provided:
+ 
+ Real image file.
+ Its mime type is into the list of allowed mime types.
+ Its metadata fields do not contains any characters related to a malicious payloads.
+ 
  <br>
  <b>Important note:</b> This implementation is prone to bypass using the "<b>raw insertion</b>" method documented in the <a href="https://www.synacktiv.com/en/publications/persistent-php-payloads-in-pngs-how-to-inject-php-code-in-an-image-and-keep-it-there">blog post</a> from the Synacktiv team.</div>
 </dd>
 <dt><a href="eu/righettod/SecurityUtils.html#isJSONSafe(java.lang.String,int,int)" class="member-name-link">isJSONSafe(String, int, int)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
 <dd>
-<div class="block">Apply a collection of validations on a JSON string provided:<br>
- - Real JSON structure.<br>
- - Contain less than a specified number of deepness for nested objects or arrays.<br>
- - Contain less than a specified number of items in any arrays.<br><br>
-
+<div class="block">Apply a collection of validations on a JSON string provided:
+ 
+ Real JSON structure.
+ Contain less than a specified number of deepness for nested objects or arrays.
+ Contain less than a specified number of items in any arrays.
+ 
+ <br>
  <b>Note:</b> I decided to use a parsing approach using only string processing to prevent any StackOverFlow or OutOfMemory error that can be abused.<br><br>
  I used the following assumption:
  
@@ -153,23 +158,35 @@ <h2 class="title" id="I:I">I</h2>
       The character sequence <code>\"</code> identify the escaping of an double quote.
  </div>
 </dd>
+<dt><a href="eu/righettod/SecurityUtils.html#isPathSafe(java.lang.String)" class="member-name-link">isPathSafe(String)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
+<dd>
+<div class="block">Apply a collection of validations on a string expected to be an system file/folder path:
+ 
+ Does not contains path traversal payload.
+ <br></div>
+</dd>
 <dt><a href="eu/righettod/SecurityUtils.html#isPDFSafe(java.lang.String)" class="member-name-link">isPDFSafe(String)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
 <dd>
-<div class="block">Apply a collection of validations on a PDF file provided:<br>
- - Real PDF file<br>
- - No attachments.<br>
- - No Javascript code.<br>
- - No links using action of type URI/Launch/RemoteGoTo/ImportData.<br></div>
+<div class="block">Apply a collection of validations on a PDF file provided:
+ 
+ Real PDF file.
+ No attachments.
+ No Javascript code.
+ No links using action of type URI/Launch/RemoteGoTo/ImportData.
+ </div>
 </dd>
 <dt><a href="eu/righettod/SecurityUtils.html#isPSD2StetSafeCertificateURL(java.lang.String)" class="member-name-link">isPSD2StetSafeCertificateURL(String)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
 <dd>
 <div class="block">The <a href="https://www.stet.eu/en/psd2/">PSD2 STET</a> specification require to use <a href="https://datatracker.ietf.org/doc/draft-cavage-http-signatures/">HTTP Signature</a>.</div>
 </dd>
 <dt><a href="eu/righettod/SecurityUtils.html#isPublicIPAddress(java.lang.String)" class="member-name-link">isPublicIPAddress(String)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
 <dd>
-<div class="block">Apply a collection of validations on a string expected to be an public IP address:<br>
- - Is a valid IP v4 or v6 address.<br>
- - Is public from an Internet perspective.<br><br>
+<div class="block">Apply a collection of validations on a string expected to be an public IP address:
+ 
+ Is a valid IP v4 or v6 address.
+ Is public from an Internet perspective.
+ 
+ <br>
  <b>Note:</b> I often see missing such validation in the value read from HTTP request headers like "X-Forwarded-For" or "Forwarded".</div>
 </dd>
 <dt><a href="eu/righettod/SecurityUtils.html#isRelativeURL(java.lang.String)" class="member-name-link">isRelativeURL(String)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
@@ -180,17 +197,21 @@ <h2 class="title" id="I:I">I</h2>
 <dd>
 <div class="block">Apply a collection of validation to verify if a provided PIN code is considered weak (easy to guess) or none.<br>
  This method consider that format of the PIN code is [0-9]{6,}<br>
- Rule to consider a PIN code as weak:<br>
- - Length is inferior to 6 positions.<br>
- - Contain only the same number or only a sequence of zero.<br>
- - Contain sequence of following incremental or decremental numbers.<br></div>
+ Rule to consider a PIN code as weak:
+ 
+ Length is inferior to 6 positions.
+ Contain only the same number or only a sequence of zero.
+ Contain sequence of following incremental or decremental numbers.
+ </div>
 </dd>
 <dt><a href="eu/righettod/SecurityUtils.html#isWord972003DocumentSafe(java.lang.String)" class="member-name-link">isWord972003DocumentSafe(String)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
 <dd>
-<div class="block">Apply a collection of validations on a Word 97-2003 (binary format) document file provided:<br>
- - Real Microsoft Word 97-2003 document file.<br>
- - No VBA Macro.<br>
- - No embedded objects.<br></div>
+<div class="block">Apply a collection of validations on a Word 97-2003 (binary format) document file provided:
+ 
+ Real Microsoft Word 97-2003 document file.
+ No VBA Macro.<br>
+ No embedded objects.
+ </div>
 </dd>
 <dt><a href="eu/righettod/SecurityUtils.html#isXMLOnlyUseAllowedXSDorDTD(java.lang.String,java.util.List)" class="member-name-link">isXMLOnlyUseAllowedXSDorDTD(String, List&lt;String&gt;)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
 <dd>
@@ -204,10 +225,12 @@ <h2 class="title" id="I:I">I</h2>
 </dd>
 <dt><a href="eu/righettod/SecurityUtils.html#isZIPSafe(java.lang.String,int,boolean)" class="member-name-link">isZIPSafe(String, int, boolean)</a> - Static method in class eu.righettod.<a href="eu/righettod/SecurityUtils.html" title="class in eu.righettod">SecurityUtils</a></dt>
 <dd>
-<div class="block">Apply a collection of validations on a ZIP file provided:<br>
- - Real ZIP file<br>
- - Contain less than a specified level of deepness.<br>
- - Do not contain Zip-Slip entry path.<br></div>
+<div class="block">Apply a collection of validations on a ZIP file provided:
+ 
+ Real ZIP file.
+ Contain less than a specified level of deepness.
+ Do not contain Zip-Slip entry path.
+ </div>
 </dd>
 </dl>
 <h2 class="title" id="I:P">P</h2>
diff --git a/docs/index.html b/docs/index.html
@@ -1,11 +1,11 @@
 <!DOCTYPE HTML>
 <html lang>
 <head>
-<!-- Generated by javadoc (21) on Fri Oct 25 13:46:12 UTC 2024 -->
+<!-- Generated by javadoc (21) on Sun Oct 27 09:20:29 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">
-<meta name="dc.created" content="2024-10-25">
+<meta name="dc.created" content="2024-10-27">
 <meta name="description" content="index redirect">
 <meta name="generator" content="javadoc/IndexRedirectWriter">
 <link rel="canonical" href="eu/righettod/package-summary.html">
diff --git a/docs/member-search-index.js b/docs/member-search-index.js
diff --git a/docs/overview-tree.html b/docs/overview-tree.html
diff --git a/docs/search.html b/docs/search.html
diff --git a/docs/src-html/eu/righettod/SecurityUtils.html b/docs/src-html/eu/righettod/SecurityUtils.html
