Release v2.1.0

auth0 · Oct 23, 2019 · e59a2be · e59a2be
1 parent 1bbd1dd
commit e59a2be
Show file tree

Hide file tree

Showing 14 changed files with 226 additions and 89 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Change Log
 
+## [v2.1.0](https://github.com/auth0/react-native-auth0/tree/v2.1.0) (2019-10-23)
+
+[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v2.0.0...v2.1.0)
+
+**Security**
+
+- Improved OIDC compliance [\#243](https://github.com/auth0/react-native-auth0/pull/243) ([jimmyjames](https://github.com/jimmyjames))
+
 ## [v2.0.0](https://github.com/auth0/react-native-auth0/tree/v2.0.0) (2019-10-08)
 
 This is a major release that supports **CocoaPods** and **Android X**.

diff --git a/docs/Auth.html b/docs/Auth.html
@@ -1379,7 +1379,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Tue Oct 08 2019 15:17:20 GMT-0300 (Argentina Standard Time) using the
+      Wed Oct 23 2019 15:23:35 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/Auth0.html b/docs/Auth0.html
@@ -194,7 +194,7 @@ <h3 class="subsection-title">Classes</h3>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Tue Oct 08 2019 15:17:20 GMT-0300 (Argentina Standard Time) using the
+      Wed Oct 23 2019 15:23:35 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/Auth0.module.exports.html b/docs/Auth0.module.exports.html
@@ -259,7 +259,7 @@ <h5>Parameters:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Tue Oct 08 2019 15:17:20 GMT-0300 (Argentina Standard Time) using the
+      Wed Oct 23 2019 15:23:35 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/Users.html b/docs/Users.html
@@ -427,7 +427,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Tue Oct 08 2019 15:17:20 GMT-0300 (Argentina Standard Time) using the
+      Wed Oct 23 2019 15:23:35 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/WebAuth.html b/docs/WebAuth.html
@@ -178,7 +178,7 @@ <h4 class="name" id="WebAuth">
                     <li>
                       <a href="src_webauth_index.js.html"
                         >src/webauth/index.js</a
-                      >, <a href="src_webauth_index.js.html#line16">line 16</a>
+                      >, <a href="src_webauth_index.js.html#line17">line 17</a>
                     </li>
                   </ul>
                 </dd>
@@ -204,7 +204,7 @@ <h3 class="subsection-title">Methods</h3>
             <h4 class="name" id=".authorize">
               <span class="type-signature">(static) </span>authorize<span
                 class="signature"
-                >(parameters)</span
+                >(parameters, options)</span
               ><span class="type-signature"> &rarr; {Promise}</span>
             </h4>
 
@@ -230,7 +230,7 @@ <h4 class="name" id=".authorize">
                 <ul class="dummy">
                   <li>
                     <a href="src_webauth_index.js.html">src/webauth/index.js</a
-                    >, <a href="src_webauth_index.js.html#line54">line 54</a>
+                    >, <a href="src_webauth_index.js.html#line58">line 58</a>
                   </li>
                 </ul>
               </dd>
@@ -270,7 +270,7 @@ <h5>Parameters:</h5>
                   </td>
 
                   <td class="description last">
-                    <p>parameters to send</p>
+                    <p>parameters to send on the AuthN/AuthZ request.</p>
 
                     <table class="params">
                       <thead>
@@ -373,6 +373,69 @@ <h5>Parameters:</h5>
                             </p>
                           </td>
                         </tr>
+
+                        <tr>
+                          <td class="name"><code>max_age</code></td>
+
+                          <td class="type">
+                            <span class="param-type"><code>Number</code></span>
+                          </td>
+
+                          <td class="attributes">&lt;optional><br /></td>
+
+                          <td class="description last">
+                            <p>
+                              The allowable elapsed time in seconds since the
+                              last time the user was authenticated (optional).
+                            </p>
+                          </td>
+                        </tr>
+                      </tbody>
+                    </table>
+                  </td>
+                </tr>
+
+                <tr>
+                  <td class="name"><code>options</code></td>
+
+                  <td class="type">
+                    <span class="param-type"><code>Object</code></span>
+                  </td>
+
+                  <td class="description last">
+                    <p>options for ID token validation configuration.</p>
+
+                    <table class="params">
+                      <thead>
+                        <tr>
+                          <th>Name</th>
+
+                          <th>Type</th>
+
+                          <th>Attributes</th>
+
+                          <th class="last">Description</th>
+                        </tr>
+                      </thead>
+
+                      <tbody>
+                        <tr>
+                          <td class="name"><code>leeway</code></td>
+
+                          <td class="type">
+                            <span class="param-type"><code>Number</code></span>
+                          </td>
+
+                          <td class="attributes">&lt;optional><br /></td>
+
+                          <td class="description last">
+                            <p>
+                              The amount of leeway, in seconds, to accommodate
+                              potential clock skew when validating an ID token's
+                              claims. Defaults to 60 seconds if not specified.
+                            </p>
+                          </td>
+                        </tr>
                       </tbody>
                     </table>
                   </td>
@@ -419,7 +482,7 @@ <h4 class="name" id=".clearSession">
                 <ul class="dummy">
                   <li>
                     <a href="src_webauth_index.js.html">src/webauth/index.js</a
-                    >, <a href="src_webauth_index.js.html#line109">line 109</a>
+                    >, <a href="src_webauth_index.js.html#line125">line 125</a>
                   </li>
                 </ul>
               </dd>
@@ -515,7 +578,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Tue Oct 08 2019 15:17:20 GMT-0300 (Argentina Standard Time) using the
+      Wed Oct 23 2019 15:23:35 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/global.html b/docs/global.html
@@ -233,7 +233,7 @@ <h5>Returns:</h5>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Tue Oct 08 2019 15:17:20 GMT-0300 (Argentina Standard Time) using the
+      Wed Oct 23 2019 15:23:35 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>
 

diff --git a/docs/index.html b/docs/index.html
@@ -146,6 +146,10 @@
       <section class="readme">
         <article>
           <h1>react-native-auth0</h1>
+          <p>
+            React Native toolkit for Auth0 API, compliant with
+            <a href="https://tools.ietf.org/html/rfc8252">RFC 8252</a>
+          </p>
           <p>
             <a href="https://circleci.com/gh/auth0/react-native-auth0"
               ><img
@@ -173,10 +177,50 @@ <h1>react-native-auth0</h1>
                 alt="Downloads"
             /></a>
           </p>
-          <p>
-            React Native toolkit for Auth0 API, compliant with
-            <a href="https://tools.ietf.org/html/rfc8252">RFC 8252</a>
-          </p>
+          <h2>Table of Contents</h2>
+          <ul>
+            <li><a href="#documentation">Documentation</a></li>
+            <li><a href="#requirements">Requirements</a></li>
+            <li><a href="#getting-started">Getting Started</a></li>
+            <li><a href="#usage">Usage</a></li>
+            <li><a href="#support--feedback">Support + Feedback</a></li>
+            <li>
+              <a href="#vulnerability-reporting">Vulnerability Reporting</a>
+            </li>
+            <li><a href="#thank-you">Thank You</a></li>
+            <li><a href="#what-is-auth0">What is Auth0</a></li>
+            <li><a href="#license">License</a></li>
+          </ul>
+          <h2>Documentation</h2>
+          <ul>
+            <li>
+              The
+              <a href="https://auth0.com/docs/quickstart/native/react-native"
+                >React Native Quickstart</a
+              >
+              shows how to get an iOS or Android app running from scratch.
+            </li>
+            <li>
+              The
+              <a
+                href="https://github.com/auth0-samples/auth0-react-native-sample/tree/master/00-Login"
+                >React Native Sample</a
+              >
+              has complete, running iOS and Android applications you can try.
+            </li>
+            <li>
+              The <a href="#usage">Usage</a> section below covers specific use
+              cases outside of basic authentication.
+            </li>
+            <li>
+              The
+              <a href="https://auth0.github.io/react-native-auth0/"
+                >API documentation</a
+              >
+              is generated from the code and explains all methods that are able
+              to be used.
+            </li>
+          </ul>
           <h2>Requirements</h2>
           <p>
             This SDK targets apps that are using React Native SDK version
@@ -216,7 +260,7 @@ <h3>Compatibility Matrix</h3>
               >branch v1</a
             >.
           </p>
-          <h2>Getting started</h2>
+          <h2>Getting Started</h2>
           <p>First install the native library module:</p>
           <p>Using <a href="https://www.npmjs.com">npm</a></p>
           <p><code>$ npm install react-native-auth0 --save</code></p>
@@ -554,71 +598,77 @@ <h3>Get full user profile</h3>
               >documentation</a
             >
           </p>
-          <h2>What is Auth0?</h2>
-          <p>Auth0 helps you to:</p>
+          <h2>Contributing</h2>
+          <p>
+            We appreciate feedback and contribution to this repo! Before you get
+            started, please see the following:
+          </p>
           <ul>
             <li>
-              Add authentication with
-              <a href="https://docs.auth0.com/identityproviders"
-                >multiple authentication sources</a
-              >, either social like
-              <strong
-                >Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter,
-                Box, Salesforce, amont others</strong
-              >, or enterprise identity systems like
-              <strong
-                >Windows Azure AD, Google Apps, Active Directory, ADFS or any
-                SAML Identity Provider</strong
-              >.
-            </li>
-            <li>
-              Add authentication through more traditional
-              <strong
-                ><a href="https://docs.auth0.com/mysql-connection-tutorial"
-                  >username/password databases</a
-                ></strong
-              >.
+              <a
+                href="https://github.com/auth0/.github/blob/master/CONTRIBUTING.md"
+                >Auth0's general contribution guidelines</a
+              >
             </li>
             <li>
-              Add support for
-              <strong
-                ><a href="https://docs.auth0.com/link-accounts"
-                  >linking different user accounts</a
-                ></strong
+              <a
+                href="https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md"
+                >Auth0's code of conduct guidelines</a
               >
-              with the same user.
             </li>
+            <li><a href="DEVELOPMENT.md">This repo's development guide</a></li>
+          </ul>
+          <h2>Support + Feedback</h2>
+          <ul>
             <li>
-              Support for generating signed
-              <a href="https://docs.auth0.com/jwt">Json Web Tokens</a> to call
-              your APIs and <strong>flow the user identity</strong> securely.
+              Use
+              <a href="https://github.com/auth0/react-native-auth0/issues"
+                >Issues</a
+              >
+              for code-level support
             </li>
-            <li>Analytics of how, when and where users are logging in.</li>
             <li>
-              Pull data from other sources and add it to the user profile,
-              through
-              <a href="https://docs.auth0.com/rules">JavaScript rules</a>.
+              Use <a href="https://community.auth0.com/">Community</a> for
+              usage, questions, specific cases
             </li>
           </ul>
-          <h2>Create a free Auth0 Account</h2>
-          <ol>
-            <li>
-              Go to <a href="https://auth0.com">Auth0</a> and click Sign Up.
-            </li>
-            <li>Use Google, GitHub or Microsoft Account to login.</li>
-          </ol>
-          <h2>Issue Reporting</h2>
+          <h2>Vulnerability Reporting</h2>
           <p>
-            If you have found a bug or if you have a feature request, please
-            report them at this repository issues section. Please do not report
-            security vulnerabilities on the public GitHub issue tracker. The
-            <a href="https://auth0.com/whitehat"
+            Please do not report security vulnerabilities on the public GitHub
+            issue tracker. The
+            <a href="https://auth0.com/responsible-disclosure-policy/"
               >Responsible Disclosure Program</a
             >
             details the procedure for disclosing security issues.
           </p>
-          <h2>Author</h2>
-          <p><a href="auth0.com">Auth0</a></p>
+          <h2>What is Auth0?</h2>
+          <p>Auth0 helps you to easily:</p>
+          <ul>
+            <li>
+              implement authentication with multiple identity providers,
+              including social (e.g., Google, Facebook, Microsoft, LinkedIn,
+              GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD,
+              Google Apps, Active Directory, ADFS, SAML, etc.)
+            </li>
+            <li>
+              log in users with username/password databases, passwordless, or
+              multi-factor authentication
+            </li>
+            <li>link multiple user accounts together</li>
+            <li>
+              generate signed JSON Web Tokens to authorize your API calls and
+              flow the user identity securely
+            </li>
+            <li>
+              access demographics and analytics detailing how, when, and where
+              users are logging in
+            </li>
+            <li>
+              enrich user profiles from other data sources using customizable
+              JavaScript rules
+            </li>
+          </ul>
+          <p><a href="https://auth0.com/why-auth0">Why Auth0?</a></p>
           <h2>License</h2>
           <p>
             This project is licensed under the MIT license. See the
@@ -633,7 +683,7 @@ <h2>License</h2>
 
     <footer>
       Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on
-      Tue Oct 08 2019 15:17:20 GMT-0300 (Argentina Standard Time) using the
+      Wed Oct 23 2019 15:23:35 GMT-0300 (Argentina Standard Time) using the
       Minami theme.
     </footer>