Skip to content

Commit

Permalink
Merge pull request #34 from auth0/release/v1.0.0
Browse files Browse the repository at this point in the history 
Release v1.0.0
  • Loading branch information
@adamjmcgrath
adamjmcgrath authored Oct 21, 2021
2 parents 6a85a07 + 9d09818 commit b34cc70
Show file tree
Hide file tree
Showing 10 changed files with 67 additions and 45 deletions.
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Monorepo for `oauth2-jwt-bearer`. Contains the following packages:
|-------------------------------------------------------------------|:---------:|------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [oauth2-bearer](./packages/oauth2-bearer) | ✘ | Gets Bearer tokens from a request and issues errors per [rfc6750](https://tools.ietf.org/html/rfc6750) |
| [access-token-jwt](./packages/access-token-jwt) | ✘ | Verfies and decodes Access Token JWTs loosley following [draft-ietf-oauth-access-token-jwt-12](https://tools.ietf.org/html/draft-ietf-oauth-access-token-jwt-12) |
| [express-oauth2-jwt-bearer](./packages/express-oauth2-jwt-bearer) | ✔ | Authentication middleware for Express.js that validates JWT Bearer Access Tokens (Beta) |
| [express-oauth2-jwt-bearer](./packages/express-oauth2-jwt-bearer) | ✔ | Authentication middleware for Express.js that validates JWT Bearer Access Tokens |

## Developing

Expand Down
12 changes: 6 additions & 6 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ <h3>JSONPrimitive</h3>
<div class="tsd-signature tsd-kind-icon">JSONPrimitive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/claim-check.ts#L8">packages/access-token-jwt/src/claim-check.ts:8</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/claim-check.ts#L8">packages/access-token-jwt/src/claim-check.ts:8</a></li>
</ul>
</aside>
</section>
Expand All @@ -114,7 +114,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> auth</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/express-oauth2-jwt-bearer/src/index.ts#L62">packages/express-oauth2-jwt-bearer/src/index.ts:62</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/express-oauth2-jwt-bearer/src/index.ts#L62">packages/express-oauth2-jwt-bearer/src/index.ts:62</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -169,7 +169,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> claim<wbr>Check</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/express-oauth2-jwt-bearer/src/index.ts#L108">packages/express-oauth2-jwt-bearer/src/index.ts:108</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/express-oauth2-jwt-bearer/src/index.ts#L108">packages/express-oauth2-jwt-bearer/src/index.ts:108</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -227,7 +227,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> claim<wbr>Equals</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/express-oauth2-jwt-bearer/src/index.ts#L122">packages/express-oauth2-jwt-bearer/src/index.ts:122</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/express-oauth2-jwt-bearer/src/index.ts#L122">packages/express-oauth2-jwt-bearer/src/index.ts:122</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -264,7 +264,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> claim<wbr>Includes</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/express-oauth2-jwt-bearer/src/index.ts#L137">packages/express-oauth2-jwt-bearer/src/index.ts:137</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/express-oauth2-jwt-bearer/src/index.ts#L137">packages/express-oauth2-jwt-bearer/src/index.ts:137</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -302,7 +302,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> required<wbr>Scopes</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/express-oauth2-jwt-bearer/src/index.ts#L152">packages/express-oauth2-jwt-bearer/src/index.ts:152</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/express-oauth2-jwt-bearer/src/index.ts#L152">packages/express-oauth2-jwt-bearer/src/index.ts:152</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
26 changes: 13 additions & 13 deletions docs/interfaces/authoptions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> agent</h3>
<div class="tsd-signature tsd-kind-icon">agent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Agent</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Agent</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L53">packages/access-token-jwt/src/jwt-verifier.ts:53</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L50">packages/access-token-jwt/src/jwt-verifier.ts:50</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -122,7 +122,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> audience</h3>
<div class="tsd-signature tsd-kind-icon">audience<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L32">packages/access-token-jwt/src/jwt-verifier.ts:32</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L29">packages/access-token-jwt/src/jwt-verifier.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -138,7 +138,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> clock<wbr>Tolerance</
<div class="tsd-signature tsd-kind-icon">clock<wbr>Tolerance<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L96">packages/access-token-jwt/src/jwt-verifier.ts:96</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L93">packages/access-token-jwt/src/jwt-verifier.ts:93</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -154,7 +154,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> cooldown<wbr>Duration
<div class="tsd-signature tsd-kind-icon">cooldown<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L60">packages/access-token-jwt/src/jwt-verifier.ts:60</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L57">packages/access-token-jwt/src/jwt-verifier.ts:57</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -171,7 +171,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> issuer</h3>
<div class="tsd-signature tsd-kind-icon">issuer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L39">packages/access-token-jwt/src/jwt-verifier.ts:39</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L36">packages/access-token-jwt/src/jwt-verifier.ts:36</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -188,7 +188,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> issuer<wbr>BaseURL</h
<div class="tsd-signature tsd-kind-icon">issuer<wbr>BaseURL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L26">packages/access-token-jwt/src/jwt-verifier.ts:26</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L23">packages/access-token-jwt/src/jwt-verifier.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -209,7 +209,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> jwks<wbr>Uri</h3>
<div class="tsd-signature tsd-kind-icon">jwks<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L47">packages/access-token-jwt/src/jwt-verifier.ts:47</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L44">packages/access-token-jwt/src/jwt-verifier.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -227,7 +227,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr>Token<wbr>Age
<div class="tsd-signature tsd-kind-icon">max<wbr>Token<wbr>Age<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L102">packages/access-token-jwt/src/jwt-verifier.ts:102</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L99">packages/access-token-jwt/src/jwt-verifier.ts:99</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -243,7 +243,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> secret</h3>
<div class="tsd-signature tsd-kind-icon">secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L116">packages/access-token-jwt/src/jwt-verifier.ts:116</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L113">packages/access-token-jwt/src/jwt-verifier.ts:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -259,7 +259,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> strict</h3>
<div class="tsd-signature tsd-kind-icon">strict<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L110">packages/access-token-jwt/src/jwt-verifier.ts:110</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L107">packages/access-token-jwt/src/jwt-verifier.ts:107</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -277,7 +277,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> timeout<wbr>Duration<
<div class="tsd-signature tsd-kind-icon">timeout<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L67">packages/access-token-jwt/src/jwt-verifier.ts:67</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L64">packages/access-token-jwt/src/jwt-verifier.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -294,7 +294,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> token<wbr>Signing<wbr
<div class="tsd-signature tsd-kind-icon">token<wbr>Signing<wbr>Alg<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L125">packages/access-token-jwt/src/jwt-verifier.ts:125</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L122">packages/access-token-jwt/src/jwt-verifier.ts:122</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -313,7 +313,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> validators</h3>
<div class="tsd-signature tsd-kind-icon">validators<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Validators</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L90">packages/access-token-jwt/src/jwt-verifier.ts:90</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L87">packages/access-token-jwt/src/jwt-verifier.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
6 changes: 3 additions & 3 deletions docs/interfaces/authresult.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ <h3>header</h3>
<div class="tsd-signature tsd-kind-icon">header<span class="tsd-signature-symbol">:</span> <a href="jwtheader.html" class="tsd-signature-type" data-tsd-kind="Interface">JWTHeader</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L132">packages/access-token-jwt/src/jwt-verifier.ts:132</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L129">packages/access-token-jwt/src/jwt-verifier.ts:129</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -111,7 +111,7 @@ <h3>payload</h3>
<div class="tsd-signature tsd-kind-icon">payload<span class="tsd-signature-symbol">:</span> <a href="jwtpayload.html" class="tsd-signature-type" data-tsd-kind="Interface">JWTPayload</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L136">packages/access-token-jwt/src/jwt-verifier.ts:136</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L133">packages/access-token-jwt/src/jwt-verifier.ts:133</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -126,7 +126,7 @@ <h3>token</h3>
<div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/47a6430/packages/access-token-jwt/src/jwt-verifier.ts#L140">packages/access-token-jwt/src/jwt-verifier.ts:140</a></li>
<li>Defined in <a href="https://github.com/auth0/node-oauth2-jwt-bearer/blob/460d199/packages/access-token-jwt/src/jwt-verifier.ts#L137">packages/access-token-jwt/src/jwt-verifier.ts:137</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit b34cc70

Please sign in to comment.