@digicatapult/tsoa-oauth-express 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +201 -0
- package/README.md +104 -0
- package/build/index.d.mts +5 -0
- package/build/index.d.ts +19 -0
- package/build/index.js +87 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +4 -0
- package/build/index.mjs.map +1 -0
- package/package.json +48 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [2024] [Digital Catapult]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# tsoa-oauth-express
|
|
2
|
+
|
|
3
|
+
This library enables easy implementation of OAuth2 authentication for [tsoa](https://tsoa-community.github.io/docs/) on [express](http://expressjs.com/). To use this library first add it as an `npm` dependency to your existing `tsoa` application.
|
|
4
|
+
|
|
5
|
+
```sh
|
|
6
|
+
npm i @digicatapult/tsoa-oauth-express
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
Your authentication file (see tsoa's documentation on authentication setup [here](https://tsoa-community.github.io/docs/authentication.html)) will then need to contain something like:
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
import type express from 'express'
|
|
13
|
+
import type * as jwt from 'jsonwebtoken'
|
|
14
|
+
|
|
15
|
+
import mkExpressAuthentication, { AuthOptions } from '@digicatapult/tsoa-oauth-express'
|
|
16
|
+
|
|
17
|
+
// module options
|
|
18
|
+
const options: AuthOptions = {
|
|
19
|
+
...
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export const expressAuthentication = mkExpressAuthentication(options)
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
where the `options` value is an object with the following type and properties:
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
interface AuthOptions {
|
|
29
|
+
securityName?: string
|
|
30
|
+
verifyOptions?: jwt.VerifyOptions & { complete?: false }
|
|
31
|
+
jwksUri: () => Promise<string>
|
|
32
|
+
getAccessToken: (req: express.Request) => Promise<string | undefined>
|
|
33
|
+
getScopesFromToken: (decoded: string | jwt.JwtPayload) => Promise<string[]>
|
|
34
|
+
tryRefreshTokens: (req: express.Request) => Promise<boolean>
|
|
35
|
+
}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
| property | required | description |
|
|
39
|
+
| ------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
40
|
+
| jwksUri | `true` | Resolves to the `uri` for your identity providers `jwks` configuration |
|
|
41
|
+
| getAccessToken | `true` | Resolves a JWT from the `Request`. For example this may come from an `authorization` header or a `cookie` based on requirements |
|
|
42
|
+
| getScopesFromToken | `true` | Resolves to an array of OAuth scopes that the provided token supports |
|
|
43
|
+
| securityName | `false` | `OpenAPI` Security scheme name to be secured |
|
|
44
|
+
| verifyOptions | `false` | `jsonwebtoken` verification options. See the [jsonwebtoken documentation](https://www.npmjs.com/package/jsonwebtoken#jwtverifytoken-secretorpublickey-options-callback) for details |
|
|
45
|
+
| tryRefreshTokens | `false` | Performs a token refresh. Resolves to `true` if the refressh succeeded otherwise `false`. By default this always resolves to `false` |
|
|
46
|
+
|
|
47
|
+
## Example
|
|
48
|
+
|
|
49
|
+
An example implementation of using the OAuth client-credential flow to authenticate a machine-to-machine (m2m) API is included in the package repository. This consists of two parts, a pre-configured `Keycloak` instance which can be instantiated with `docker compose` to act as our identity provider and an example application under [./example](./example) which implements to `tsoa` server. For further information please see the [tsoa authentication documentation](https://tsoa-community.github.io/docs/authentication.html) and our authentication handler example at [./example/authentication.ts](./example/authentication.ts).
|
|
50
|
+
|
|
51
|
+
To get started first bring up the `Keycloak` instance by executing from the repository root:
|
|
52
|
+
|
|
53
|
+
```sh
|
|
54
|
+
docker compose up -d
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
This will automatically pre-configure a client called `example` with client secret `example`. We can then fetch a m2m token by executing:
|
|
58
|
+
|
|
59
|
+
```sh
|
|
60
|
+
curl --request POST \
|
|
61
|
+
--url 'http://localhost:3080/realms/example/protocol/openid-connect/token' \
|
|
62
|
+
--header 'content-type: application/x-www-form-urlencoded' \
|
|
63
|
+
--data grant_type=client_credentials \
|
|
64
|
+
--data client_id=example \
|
|
65
|
+
--data client_secret=example
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
This will return a JSON object with a JWT auth token in the `access_token` property that takes the form like `eyJhbGci...r8TIOfRQ`.
|
|
69
|
+
|
|
70
|
+
The example server can then be run with:
|
|
71
|
+
|
|
72
|
+
```sh
|
|
73
|
+
npm run example
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
This server listens on port 3000 and exposes two routes `/authenticated` and `/unauthenticated` where only the first route requires an auth token. So we can for example call
|
|
77
|
+
|
|
78
|
+
```sh
|
|
79
|
+
curl http://localhost:3000/unauthenticated
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
which should return something like
|
|
83
|
+
|
|
84
|
+
```json
|
|
85
|
+
{ "message": "This route is unauthenticated", "authenticated": false }
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
But calling the authenticated route (`curl http://localhost:3000/authenticated`) in the same was will return an error
|
|
89
|
+
|
|
90
|
+
```json
|
|
91
|
+
{ "message": "unauthenticated" }
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Providing the JWT auth token as part of an authentication header:
|
|
95
|
+
|
|
96
|
+
```sh
|
|
97
|
+
curl http://localhost:3000/authenticated --header 'authorization: bearer eyJhbGci...r8TIOfRQ'
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
causes the call to succeed:
|
|
101
|
+
|
|
102
|
+
```json
|
|
103
|
+
{ "message": "This route is authenticated", "authenticated": true }
|
|
104
|
+
```
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import mkExpressAuthentication from './index.js';
|
|
2
|
+
export type { AuthOptions, ErrorReason, TsoaExpressAuthenticator } from './index.js';
|
|
3
|
+
export { OauthError } from './index.js';
|
|
4
|
+
declare const _default: typeof mkExpressAuthentication.default;
|
|
5
|
+
export default _default;
|
package/build/index.d.ts
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import type express from 'express';
|
|
2
|
+
import jwt from 'jsonwebtoken';
|
|
3
|
+
export type ErrorReason = 'INVALID_SECURITY_TYPE' | 'NO_TOKEN' | 'MISSING_SCOPES' | 'INVALID_TOKEN';
|
|
4
|
+
export declare class OauthError extends Error {
|
|
5
|
+
reason: ErrorReason;
|
|
6
|
+
constructor(reason: ErrorReason);
|
|
7
|
+
}
|
|
8
|
+
export interface AuthOptions {
|
|
9
|
+
securityName?: string;
|
|
10
|
+
verifyOptions?: jwt.VerifyOptions & {
|
|
11
|
+
complete?: false;
|
|
12
|
+
};
|
|
13
|
+
jwksUri: () => Promise<string>;
|
|
14
|
+
getAccessToken: (req: express.Request) => Promise<string | undefined>;
|
|
15
|
+
getScopesFromToken: (decoded: string | jwt.JwtPayload) => Promise<string[]>;
|
|
16
|
+
tryRefreshTokens?: (req: express.Request) => Promise<boolean>;
|
|
17
|
+
}
|
|
18
|
+
export type TsoaExpressAuthenticator = (request: express.Request, securityName: string, scopes?: string[]) => Promise<void>;
|
|
19
|
+
export default function mkExpressAuthentication(options: AuthOptions): TsoaExpressAuthenticator;
|
package/build/index.js
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.OauthError = void 0;
|
|
7
|
+
const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
|
|
8
|
+
const jwks_rsa_1 = __importDefault(require("jwks-rsa"));
|
|
9
|
+
class OauthError extends Error {
|
|
10
|
+
constructor(reason) {
|
|
11
|
+
super(`Auth failed for reason: ${reason}`);
|
|
12
|
+
this.reason = reason;
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
exports.OauthError = OauthError;
|
|
16
|
+
async function handleError(err, request, options) {
|
|
17
|
+
if (!err) {
|
|
18
|
+
return;
|
|
19
|
+
}
|
|
20
|
+
if (!(err instanceof jsonwebtoken_1.default.TokenExpiredError)) {
|
|
21
|
+
throw new OauthError('INVALID_TOKEN');
|
|
22
|
+
}
|
|
23
|
+
const refresh = options.tryRefreshTokens;
|
|
24
|
+
if (!refresh) {
|
|
25
|
+
throw new OauthError('INVALID_TOKEN');
|
|
26
|
+
}
|
|
27
|
+
const refreshSucceeded = await refresh(request);
|
|
28
|
+
if (!refreshSucceeded) {
|
|
29
|
+
throw new OauthError('INVALID_TOKEN');
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
async function checkScopes(token, requiredScopes, options) {
|
|
33
|
+
if (!requiredScopes || requiredScopes.length === 0) {
|
|
34
|
+
return;
|
|
35
|
+
}
|
|
36
|
+
if (!token) {
|
|
37
|
+
throw new OauthError('MISSING_SCOPES');
|
|
38
|
+
}
|
|
39
|
+
const tokenScopes = new Set(await options.getScopesFromToken(token));
|
|
40
|
+
for (const requiredScope of requiredScopes) {
|
|
41
|
+
if (!tokenScopes.has(requiredScope)) {
|
|
42
|
+
throw new OauthError('MISSING_SCOPES');
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
function mkExpressAuthentication(options) {
|
|
47
|
+
let client;
|
|
48
|
+
let requiredSecurityName = options.securityName ?? 'oauth2';
|
|
49
|
+
const assertClient = async () => {
|
|
50
|
+
if (!client) {
|
|
51
|
+
client = (0, jwks_rsa_1.default)({
|
|
52
|
+
jwksUri: await options.jwksUri(),
|
|
53
|
+
requestHeaders: {}, // Optional
|
|
54
|
+
timeout: 30000, // Defaults to 30s
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
return client;
|
|
58
|
+
};
|
|
59
|
+
const getKey = (header, callback) => {
|
|
60
|
+
client.getSigningKey(header.kid, function (err, key) {
|
|
61
|
+
if (err || !key) {
|
|
62
|
+
callback(err || new Error('Error getting jwks key'));
|
|
63
|
+
return;
|
|
64
|
+
}
|
|
65
|
+
callback(null, key.getPublicKey());
|
|
66
|
+
});
|
|
67
|
+
};
|
|
68
|
+
return async function expressAuthentication(request, securityName, scopes) {
|
|
69
|
+
await assertClient();
|
|
70
|
+
if (securityName !== requiredSecurityName) {
|
|
71
|
+
throw new OauthError('INVALID_SECURITY_TYPE');
|
|
72
|
+
}
|
|
73
|
+
const accessToken = await options.getAccessToken(request);
|
|
74
|
+
if (!accessToken) {
|
|
75
|
+
throw new OauthError('NO_TOKEN');
|
|
76
|
+
}
|
|
77
|
+
const [err, result] = await new Promise((resolve) => {
|
|
78
|
+
jsonwebtoken_1.default.verify(accessToken, getKey, options.verifyOptions, function (err, decoded) {
|
|
79
|
+
resolve([err, decoded]);
|
|
80
|
+
});
|
|
81
|
+
});
|
|
82
|
+
await handleError(err, request, options);
|
|
83
|
+
await checkScopes(result, scopes, options);
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
exports.default = mkExpressAuthentication;
|
|
87
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAEA,gEAA8B;AAC9B,wDAAsD;AAGtD,MAAa,UAAW,SAAQ,KAAK;IACnC,YAAmB,MAAmB;QACpC,KAAK,CAAC,2BAA2B,MAAM,EAAE,CAAC,CAAA;QADzB,WAAM,GAAN,MAAM,CAAa;IAEtC,CAAC;CACF;AAJD,gCAIC;AAkBD,KAAK,UAAU,WAAW,CAAC,GAAY,EAAE,OAAwB,EAAE,OAAoB;IACrF,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,OAAM;IACR,CAAC;IAED,IAAI,CAAC,CAAC,GAAG,YAAY,sBAAG,CAAC,iBAAiB,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,UAAU,CAAC,eAAe,CAAC,CAAA;IACvC,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,gBAAgB,CAAA;IACxC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,UAAU,CAAC,eAAe,CAAC,CAAA;IACvC,CAAC;IAED,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAA;IAE/C,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACtB,MAAM,IAAI,UAAU,CAAC,eAAe,CAAC,CAAA;IACvC,CAAC;AACH,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,KAA0C,EAC1C,cAAoC,EACpC,OAAoB;IAEpB,IAAI,CAAC,cAAc,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnD,OAAM;IACR,CAAC;IAED,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,MAAM,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAA;IACxC,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,MAAM,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAA;IAEpE,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;QAC3C,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,UAAU,CAAC,gBAAgB,CAAC,CAAA;QACxC,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAwB,uBAAuB,CAAC,OAAoB;IAClE,IAAI,MAAkB,CAAA;IACtB,IAAI,oBAAoB,GAAG,OAAO,CAAC,YAAY,IAAI,QAAQ,CAAA;IAE3D,MAAM,YAAY,GAAG,KAAK,IAAyB,EAAE;QACnD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,GAAG,IAAA,kBAAU,EAAC;gBAClB,OAAO,EAAE,MAAM,OAAO,CAAC,OAAO,EAAE;gBAChC,cAAc,EAAE,EAAE,EAAE,WAAW;gBAC/B,OAAO,EAAE,KAAK,EAAE,kBAAkB;aACnC,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,MAAM,CAAA;IACf,CAAC,CAAA;IAED,MAAM,MAAM,GAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE;QAC5D,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,EAAE,GAAG;YACjD,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;gBAChB,QAAQ,CAAC,GAAG,IAAI,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAA;gBACpD,OAAM;YACR,CAAC;YACD,QAAQ,CAAC,IAAI,EAAE,GAAG,CAAC,YAAY,EAAE,CAAC,CAAA;QACpC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IAED,OAAO,KAAK,UAAU,qBAAqB,CACzC,OAAwB,EACxB,YAAoB,EACpB,MAAiB;QAEjB,MAAM,YAAY,EAAE,CAAA;QAEpB,IAAI,YAAY,KAAK,oBAAoB,EAAE,CAAC;YAC1C,MAAM,IAAI,UAAU,CAAC,uBAAuB,CAAC,CAAA;QAC/C,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAA;QAEzD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,UAAU,CAAC,UAAU,CAAC,CAAA;QAClC,CAAC;QAED,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,MAAM,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,EAAE;YACjE,sBAAG,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,OAAO,CAAC,aAAa,EAAE,UAAU,GAAG,EAAE,OAAO;gBAC3E,OAAO,CAAC,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAA;YACzB,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,MAAM,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;QAExC,MAAM,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;IAC5C,CAAC,CAAA;AACH,CAAC;AApDD,0CAoDC"}
|
package/build/index.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/index.mts"],"names":[],"mappings":"AAAA,OAAO,uBAAuB,MAAM,YAAY,CAAA;AAIhD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACvC,eAAe,uBAAuB,CAAC,OAAO,CAAA"}
|
package/package.json
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@digicatapult/tsoa-oauth-express",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Authentication handler for TSOA using OAuth2 JWT tokens",
|
|
5
|
+
"main": "build/index.js",
|
|
6
|
+
"type": "commonjs",
|
|
7
|
+
"exports": {
|
|
8
|
+
"import": "./build/index.mjs",
|
|
9
|
+
"require": "./build/index.js"
|
|
10
|
+
},
|
|
11
|
+
"files": [
|
|
12
|
+
"build"
|
|
13
|
+
],
|
|
14
|
+
"scripts": {
|
|
15
|
+
"build": "tsc",
|
|
16
|
+
"check": "npm run example:build && tsc -p ./tsconfig.check.json",
|
|
17
|
+
"test": "NODE_ENV=test ./node_modules/.bin/mocha --config ./mocharc.json ./src/**/*.test.ts",
|
|
18
|
+
"depcheck": "depcheck",
|
|
19
|
+
"lint": "prettier -c ./src",
|
|
20
|
+
"lint:fix": "npm run lint -- -w",
|
|
21
|
+
"example:build": "tsoa spec-and-routes -c ./example/tsoa.json",
|
|
22
|
+
"example": "npm run example:build && node --import=tsimp/import ./example/index.ts"
|
|
23
|
+
},
|
|
24
|
+
"author": "Digital Catapult",
|
|
25
|
+
"license": "Apache-2.0",
|
|
26
|
+
"peerDependencies": {
|
|
27
|
+
"express": "^4.0.0"
|
|
28
|
+
},
|
|
29
|
+
"devDependencies": {
|
|
30
|
+
"@types/chai": "^4.3.16",
|
|
31
|
+
"@types/express": "^4.17.21",
|
|
32
|
+
"@types/mocha": "^10.0.6",
|
|
33
|
+
"@types/node": "^20.12.11",
|
|
34
|
+
"chai": "^5.1.0",
|
|
35
|
+
"depcheck": "^1.4.7",
|
|
36
|
+
"mocha": "^10.4.0",
|
|
37
|
+
"mock-jwks": "^3.1.0",
|
|
38
|
+
"prettier": "^3.2.5",
|
|
39
|
+
"prettier-plugin-organize-imports": "^3.2.4",
|
|
40
|
+
"tsimp": "^2.0.11",
|
|
41
|
+
"tsoa": "^6.2.1",
|
|
42
|
+
"typescript": "^5.4.5"
|
|
43
|
+
},
|
|
44
|
+
"dependencies": {
|
|
45
|
+
"jsonwebtoken": "^9.0.2",
|
|
46
|
+
"jwks-rsa": "^3.1.0"
|
|
47
|
+
}
|
|
48
|
+
}
|