Update docs

daegalus · Apr 6, 2023 · 09597cd · 09597cd
1 parent 3f3bc64
commit 09597cd
Show file tree

Hide file tree

Showing 27 changed files with 4,689 additions and 4,271 deletions.
diff --git a/docs/__404error.html b/docs/__404error.html
@@ -4,15 +4,15 @@
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
-  <meta name="generator" content="made with love by dartdoc 6.0.0">
+  <meta name="generator" content="made with love by dartdoc 6.1.5">
   <meta name="description" content="otp API docs, for the Dart programming language.">
   <title>otp - Dart API docs</title>
 
 
 
   <link rel="preconnect" href="https://fonts.gstatic.com">
   <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
-  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
 
   <link rel="stylesheet" href="static-assets/github.css?v1">
   <link rel="stylesheet" href="static-assets/styles.css?v1">
@@ -22,24 +22,30 @@
 </head>
 
 
-<body data-base-href="" data-using-base-href="false">
+<body data-base-href="" data-using-base-href="false" class="light-theme">
 
 <div id="overlay-under-drawer"></div>
 
 <header id="title">
-  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
+  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
   <ol class="breadcrumbs gt-separated dark hidden-xs">
     <li><a href="https://github.com/Daegalus/dart-otp">otp package</a></li>
   </ol>
   <div class="self-name">otp</div>
   <form class="search navbar-right" role="search">
     <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
   </form>
+  <div class="toggle" id="theme-button">
+    <label for="theme">
+      <input type="checkbox" id="theme" value="light-theme">
+      <span class="material-symbols-outlined">
+        brightness_4
+      </span>
+    </label>
+  </div>
 </header>
-
 <main>
 
-
   <div id="dartdoc-main-content" class="main-content">
     <h1>404: Something's gone wrong :-(</h1>
 
@@ -83,7 +89,7 @@ <h5><span class="package-name">otp</span> <span class="package-kind">package</sp
 <footer>
   <span class="no-break">
     otp
-      3.1.3
+      3.1.4
   </span>
 
 

diff --git a/docs/index.html b/docs/index.html
@@ -4,15 +4,15 @@
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
-  <meta name="generator" content="made with love by dartdoc 6.0.0">
+  <meta name="generator" content="made with love by dartdoc 6.1.5">
   <meta name="description" content="otp API docs, for the Dart programming language.">
   <title>otp - Dart API docs</title>
 
 
 
   <link rel="preconnect" href="https://fonts.gstatic.com">
   <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
-  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
 
   <link rel="stylesheet" href="static-assets/github.css?v1">
   <link rel="stylesheet" href="static-assets/styles.css?v1">
@@ -22,24 +22,30 @@
 </head>
 
 
-<body data-base-href="" data-using-base-href="false">
+<body data-base-href="" data-using-base-href="false" class="light-theme">
 
 <div id="overlay-under-drawer"></div>
 
 <header id="title">
-  <button id="sidenav-left-toggle" type="button">&nbsp;</button>
+  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
   <ol class="breadcrumbs gt-separated dark hidden-xs">
     <li><a href="https://github.com/Daegalus/dart-otp">otp package</a></li>
   </ol>
   <div class="self-name">otp</div>
   <form class="search navbar-right" role="search">
     <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
   </form>
+  <div class="toggle" id="theme-button">
+    <label for="theme">
+      <input type="checkbox" id="theme" value="light-theme">
+      <span class="material-symbols-outlined">
+        brightness_4
+      </span>
+    </label>
+  </div>
 </header>
-
 <main>
 
-
   <div id="dartdoc-main-content" class="main-content">
 
 <section class="desc markdown">
@@ -72,7 +78,7 @@ <h3 id="notes">Notes</h3>
 <p>This library does not support any other secret input other than Base32. It is what is used standard most places, and by Google Authenticator.
 If your secrets are not Base32 forms, please use my Base32 library (the one I use as a dependency for this library) or any other base32 library to encode your secret before passing it into the functions. All generate functions force decode of Base32.</p>
 <h3 id="global-settings">Global Settings</h3>
-<p><code>useTOTPPaddingForHOTP</code> (bool, default: false) 
+<p><code>useTOTPPaddingForHOTP</code> (bool, default: false)
 Uses the TOTP padding method for handling secrets bigger or smaller than the mandatory sizes for SHA256/SHA512.
 This is needed as HOTP does not have an official method of using SHA256 or SHA512 in the RFC spec and most libraries don't pad HOTP for use with SHA256 or SHA512. (examples: otplib and speakeasy from Node.js)</p>
 <p>If you enable this, it will use the same padding as TOTP (repeating the secret to the right length) but might cause incompatibilies with other libraries. I am defaulting to no padding, as this is the predominant behavior I am finding for HOTP.</p>
@@ -181,7 +187,7 @@ <h5 class="hidden-xs"><span class="package-name">otp</span> <span class="package
 <footer>
   <span class="no-break">
     otp
-      3.1.3
+      3.1.4
   </span>
 
 

diff --git a/docs/index.json b/docs/index.json
@@ -1 +1 @@
-[{"name":"otp","qualifiedName":"otp","href":"otp/otp-library.html","type":"library","overriddenDepth":0,"packageName":"otp"},{"name":"Algorithm","qualifiedName":"otp.Algorithm","href":"otp/Algorithm.html","type":"enum","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"otp","type":"library"}},{"name":"Algorithm","qualifiedName":"otp.Algorithm.Algorithm","href":"otp/Algorithm/Algorithm.html","type":"constructor","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"Algorithm","type":"enum"}},{"name":"values","qualifiedName":"otp.Algorithm.values","href":"otp/Algorithm/values-constant.html","type":"constant","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"Algorithm","type":"enum"}},{"name":"OTP","qualifiedName":"otp.OTP","href":"otp/OTP-class.html","type":"class","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"otp","type":"library"}},{"name":"OTP","qualifiedName":"otp.OTP.OTP","href":"otp/OTP/OTP.html","type":"constructor","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"constantTimeVerification","qualifiedName":"otp.OTP.constantTimeVerification","href":"otp/OTP/constantTimeVerification.html","type":"method","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"generateHOTPCode","qualifiedName":"otp.OTP.generateHOTPCode","href":"otp/OTP/generateHOTPCode.html","type":"method","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"generateHOTPCodeString","qualifiedName":"otp.OTP.generateHOTPCodeString","href":"otp/OTP/generateHOTPCodeString.html","type":"method","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"generateTOTPCode","qualifiedName":"otp.OTP.generateTOTPCode","href":"otp/OTP/generateTOTPCode.html","type":"method","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"generateTOTPCodeString","qualifiedName":"otp.OTP.generateTOTPCodeString","href":"otp/OTP/generateTOTPCodeString.html","type":"method","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"getAlgorithm","qualifiedName":"otp.OTP.getAlgorithm","href":"otp/OTP/getAlgorithm.html","type":"method","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"getInternalDigest","qualifiedName":"otp.OTP.getInternalDigest","href":"otp/OTP/getInternalDigest.html","type":"method","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"lastUsedCounter","qualifiedName":"otp.OTP.lastUsedCounter","href":"otp/OTP/lastUsedCounter.html","type":"property","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"lastUsedTime","qualifiedName":"otp.OTP.lastUsedTime","href":"otp/OTP/lastUsedTime.html","type":"property","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"randomSecret","qualifiedName":"otp.OTP.randomSecret","href":"otp/OTP/randomSecret.html","type":"method","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"remainingSeconds","qualifiedName":"otp.OTP.remainingSeconds","href":"otp/OTP/remainingSeconds.html","type":"method","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}},{"name":"useTOTPPaddingForHOTP","qualifiedName":"otp.OTP.useTOTPPaddingForHOTP","href":"otp/OTP/useTOTPPaddingForHOTP.html","type":"property","overriddenDepth":0,"packageName":"otp","enclosedBy":{"name":"OTP","type":"class"}}]
+[{"name":"otp","qualifiedName":"otp","href":"otp/otp-library.html","type":"library","overriddenDepth":0,"packageName":"otp","desc":""},{"name":"Algorithm","qualifiedName":"otp.Algorithm","href":"otp/Algorithm.html","type":"enum","overriddenDepth":0,"packageName":"otp","desc":"Hashing algorithm used to generate one time password codes","enclosedBy":{"name":"otp","type":"library","href":"otp/otp-library.html"}},{"name":"Algorithm","qualifiedName":"otp.Algorithm.Algorithm","href":"otp/Algorithm/Algorithm.html","type":"constructor","overriddenDepth":0,"packageName":"otp","desc":"","enclosedBy":{"name":"Algorithm","type":"enum","href":"otp/Algorithm.html"}},{"name":"values","qualifiedName":"otp.Algorithm.values","href":"otp/Algorithm/values-constant.html","type":"constant","overriddenDepth":0,"packageName":"otp","desc":"A constant List of the values in this enum, in order of their declaration.","enclosedBy":{"name":"Algorithm","type":"enum","href":"otp/Algorithm.html"}},{"name":"OTP","qualifiedName":"otp.OTP","href":"otp/OTP-class.html","type":"class","overriddenDepth":0,"packageName":"otp","desc":"RFC4226/RFC6238 One-Time Password / Google Authenticator Library","enclosedBy":{"name":"otp","type":"library","href":"otp/otp-library.html"}},{"name":"OTP","qualifiedName":"otp.OTP.OTP","href":"otp/OTP/OTP.html","type":"constructor","overriddenDepth":0,"packageName":"otp","desc":"","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"constantTimeVerification","qualifiedName":"otp.OTP.constantTimeVerification","href":"otp/OTP/constantTimeVerification.html","type":"method","overriddenDepth":0,"packageName":"otp","desc":"Allows you to compare 2 codes in constant time, to mitigate timing attacks for secure codes.","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"generateHOTPCode","qualifiedName":"otp.OTP.generateHOTPCode","href":"otp/OTP/generateHOTPCode.html","type":"method","overriddenDepth":0,"packageName":"otp","desc":"Generates a one time password code based on a counter you provide and increment.","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"generateHOTPCodeString","qualifiedName":"otp.OTP.generateHOTPCodeString","href":"otp/OTP/generateHOTPCodeString.html","type":"method","overriddenDepth":0,"packageName":"otp","desc":"Generates a one time password code based on a counter you provide and increment, returns as a 0 padded string.","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"generateTOTPCode","qualifiedName":"otp.OTP.generateTOTPCode","href":"otp/OTP/generateTOTPCode.html","type":"method","overriddenDepth":0,"packageName":"otp","desc":"Generates a Time-based one time password code","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"generateTOTPCodeString","qualifiedName":"otp.OTP.generateTOTPCodeString","href":"otp/OTP/generateTOTPCodeString.html","type":"method","overriddenDepth":0,"packageName":"otp","desc":"Generates a Time-based one time password code and return as a 0 padded string.","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"getAlgorithm","qualifiedName":"otp.OTP.getAlgorithm","href":"otp/OTP/getAlgorithm.html","type":"method","overriddenDepth":0,"packageName":"otp","desc":"Gets the Mac for the provided algorithm. Mostly used for testing, not very helpful outside of that.","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"getInternalDigest","qualifiedName":"otp.OTP.getInternalDigest","href":"otp/OTP/getInternalDigest.html","type":"method","overriddenDepth":0,"packageName":"otp","desc":"Mostly used for testing purposes, but this can get you the internal digest based on your settings.\nNo handholding for this function, so you need to know exactly what to pass in.","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"lastUsedCounter","qualifiedName":"otp.OTP.lastUsedCounter","href":"otp/OTP/lastUsedCounter.html","type":"property","overriddenDepth":0,"packageName":"otp","desc":"Has the last used counter for HOTP and TOTP codes. TOTP codes are Milliseconds / 1000 / interval (default 30)","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"lastUsedTime","qualifiedName":"otp.OTP.lastUsedTime","href":"otp/OTP/lastUsedTime.html","type":"property","overriddenDepth":0,"packageName":"otp","desc":"Has the last used timestamp for TOTP codes, should match what you passed into the functions last.","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"randomSecret","qualifiedName":"otp.OTP.randomSecret","href":"otp/OTP/randomSecret.html","type":"method","overriddenDepth":0,"packageName":"otp","desc":"Generates a cryptographically secure random secret in base32 string format.","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"remainingSeconds","qualifiedName":"otp.OTP.remainingSeconds","href":"otp/OTP/remainingSeconds.html","type":"method","overriddenDepth":0,"packageName":"otp","desc":"There is a method that will tell you how much time remains in the current time step window in seconds.\nInterval is your TOTP function interval value (default = 30)","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}},{"name":"useTOTPPaddingForHOTP","qualifiedName":"otp.OTP.useTOTPPaddingForHOTP","href":"otp/OTP/useTOTPPaddingForHOTP.html","type":"property","overriddenDepth":0,"packageName":"otp","desc":"Used to enable TOTP style padding of the secret for SHA256 and SHA512 usage with HOTP. False by default.","enclosedBy":{"name":"OTP","type":"class","href":"otp/OTP-class.html"}}]