piral-oidc 1.9.0-beta.8186 → 1.9.0-beta.8196
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/README.md +2 -2
- package/lib/setup.js +9 -8
- package/lib/setup.js.map +1 -1
- package/lib/types.d.ts +3 -3
- package/package.json +4 -4
- package/piral-oidc.min.js +1 -107
- package/src/setup.test.ts +1 -1
- package/src/setup.ts +12 -8
- package/src/types.ts +3 -3
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
# [Piral OIDC](https://piral.io) · [](https://github.com/smapiot/piral/blob/main/LICENSE) [](https://www.npmjs.com/package/piral-oidc) [](https://jestjs.io) [](https://discord.gg/kKJ2FZmK8t)
|
|
4
4
|
|
|
5
|
-
This is a plugin that only has a peer dependency to `piral-core`. What `piral-oidc` brings to the table is a direct integration with OpenID Connect identity providers on basis of the oidc-client library that can be used with `piral` or `piral-core`.
|
|
5
|
+
This is a plugin that only has a peer dependency to `piral-core`. What `piral-oidc` brings to the table is a direct integration with OpenID Connect identity providers on basis of the `oidc-client-ts` library that can be used with `piral` or `piral-core`.
|
|
6
6
|
|
|
7
7
|
The set includes the `getAccessToken` API to retrieve the current user's access token, as well as `getProfile` to retrieve the current user's open id claims.
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ By default, these Pilet API extensions are not integrated in `piral`, so you'd n
|
|
|
10
10
|
|
|
11
11
|
## Why and When
|
|
12
12
|
|
|
13
|
-
If you are using authorization with an OpenID Connect provider then `piral-oidc` might be a useful plugin. It uses the `oidc-client` library under the hood and exposes token functionality in common HTTP mechanisms (e.g., using `fetch` or a library such as `axios`). Pilets can get the currently available token via the pilet API.
|
|
13
|
+
If you are using authorization with an OpenID Connect provider then `piral-oidc` might be a useful plugin. It uses the `oidc-client-ts` library under the hood and exposes token functionality in common HTTP mechanisms (e.g., using `fetch` or a library such as `axios`). Pilets can get the currently available token via the pilet API.
|
|
14
14
|
|
|
15
15
|
Alternatives: Use a plugin that is specific to your method of authentication (e.g., `piral-auth` for generic user management, `piral-adal` for Microsoft, `piral-oauth2` for generic OAuth 2, etc.) or just a library.
|
|
16
16
|
|
package/lib/setup.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Log, UserManager } from 'oidc-client';
|
|
1
|
+
import { Log, UserManager, Logger } from 'oidc-client-ts';
|
|
2
2
|
import { OidcError } from './OidcError';
|
|
3
3
|
import { LogLevel, OidcErrorType } from './types';
|
|
4
4
|
const logLevelToOidcMap = {
|
|
@@ -40,12 +40,12 @@ export function setupOidcClient(config) {
|
|
|
40
40
|
monitorSession,
|
|
41
41
|
});
|
|
42
42
|
if (logLevel !== undefined) {
|
|
43
|
-
Log.
|
|
44
|
-
Log.
|
|
43
|
+
Log.setLogger(console);
|
|
44
|
+
Log.setLevel(convertLogLevelToOidcClient(logLevel));
|
|
45
45
|
}
|
|
46
46
|
else if (process.env.NODE_ENV === 'development') {
|
|
47
|
-
Log.
|
|
48
|
-
Log.
|
|
47
|
+
Log.setLogger(console);
|
|
48
|
+
Log.setLevel(Log.DEBUG);
|
|
49
49
|
}
|
|
50
50
|
if (doesWindowLocationMatch(userManager.settings.post_logout_redirect_uri)) {
|
|
51
51
|
if (isMainWindow()) {
|
|
@@ -105,7 +105,8 @@ export function setupOidcClient(config) {
|
|
|
105
105
|
* to update the parent. This is usually due to a timeout from a network error.
|
|
106
106
|
*/
|
|
107
107
|
try {
|
|
108
|
-
|
|
108
|
+
await userManager.signinSilentCallback();
|
|
109
|
+
user = await userManager.getUser();
|
|
109
110
|
}
|
|
110
111
|
catch (e) {
|
|
111
112
|
return reject(new OidcError(OidcErrorType.oidcCallback, e));
|
|
@@ -127,7 +128,7 @@ export function setupOidcClient(config) {
|
|
|
127
128
|
return reject(new OidcError(OidcErrorType.oidcCallback, e));
|
|
128
129
|
}
|
|
129
130
|
if (appUri) {
|
|
130
|
-
|
|
131
|
+
Logger.debug(`Redirecting to ${appUri} due to appUri being configured.`);
|
|
131
132
|
window.location.href = appUri;
|
|
132
133
|
return resolve({
|
|
133
134
|
shouldRender: false,
|
|
@@ -185,7 +186,7 @@ export function setupOidcClient(config) {
|
|
|
185
186
|
return userManager.signoutRedirect();
|
|
186
187
|
},
|
|
187
188
|
revoke() {
|
|
188
|
-
return userManager.
|
|
189
|
+
return userManager.revokeTokens();
|
|
189
190
|
},
|
|
190
191
|
handleAuthentication,
|
|
191
192
|
extendHeaders(req) {
|
package/lib/setup.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAQ,WAAW,EAAE,MAAM,
|
|
1
|
+
{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAQ,WAAW,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAwB,QAAQ,EAA0B,aAAa,EAAe,MAAM,SAAS,CAAC;AAE7G,MAAM,iBAAiB,GAAG;IACxB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;IAClB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;IACnB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;IAClB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;IAClB,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;CACpB,CAAC;AAEF,SAAS,uBAAuB,CAAC,SAAiB;IAChD,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,KAAK,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC;AAClE,CAAC;AAED,SAAS,2BAA2B,CAAC,KAAe;IAClD,OAAO,iBAAiB,CAAC,KAAK,CAAC,CAAC;AAClC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,MAAkB;IAChD,MAAM,EACJ,QAAQ,EACR,YAAY,EACZ,mBAAmB,EACnB,WAAW,GAAG,GAAG,QAAQ,CAAC,MAAM,OAAO,EACvC,oBAAoB,EACpB,qBAAqB,GAAG,QAAQ,CAAC,MAAM,EACvC,YAAY,EACZ,YAAY,EACZ,MAAM,EACN,QAAQ,GAAG,KAAK,EAChB,UAAU,EACV,MAAM,EACN,QAAQ,EACR,SAAS,EACT,gBAAgB,EAChB,SAAS,EACT,QAAQ,EACR,WAAW,EACX,cAAc,GACf,GAAG,MAAM,CAAC;IAEX,MAAM,YAAY,GAAG,GAAG,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,UAAU,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,GAAG,CAAC,CAAC;IAErG,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC;QAClC,SAAS,EAAE,mBAAmB;QAC9B,YAAY,EAAE,WAAW;QACzB,mBAAmB,EAAE,WAAW;QAChC,kBAAkB,EAAE,WAAW;QAC/B,wBAAwB,EAAE,qBAAqB;QAC/C,SAAS,EAAE,QAAQ;QACnB,aAAa,EAAE,YAAY;QAC3B,aAAa,EAAE,YAAY;QAC3B,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;QACxB,SAAS;QACT,gBAAgB;QAChB,UAAU,EAAE,SAAS;QACrB,aAAa,EAAE,YAAY;QAC3B,QAAQ;QACR,WAAW;QACX,cAAc;KACf,CAAC,CAAC;IAEH,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACvB,GAAG,CAAC,QAAQ,CAAC,2BAA2B,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtD,CAAC;SAAM,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;QAClD,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACvB,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,uBAAuB,CAAC,WAAW,CAAC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,CAAC;QAC3E,IAAI,YAAY,EAAE,EAAE,CAAC;YACnB,WAAW,CAAC,uBAAuB,EAAE,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,oBAAoB,EAAE,CAAC;QACrC,CAAC;IACH,CAAC;IAED,MAAM,aAAa,GAAG,GAAG,EAAE;QACzB,OAAO,IAAI,OAAO,CAAS,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACtC,WAAW;iBACR,OAAO,EAAE;iBACT,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;gBACb,IAAI,CAAC,IAAI,EAAE,CAAC;oBACV,GAAG,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC;gBAClD,CAAC;qBAAM,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,GAAG,EAAE,EAAE,CAAC;oBACrD,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBACzB,CAAC;qBAAM,CAAC;oBACN,OAAO,WAAW,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;wBAC9C,IAAI,CAAC,IAAI,EAAE,CAAC;4BACV,OAAO,GAAG,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,iBAAiB,CAAC,CAAC,CAAC;wBAC7D,CAAC;wBACD,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;4BACvB,OAAO,GAAG,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;wBACxD,CAAC;wBACD,OAAO,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;oBAChC,CAAC,CAAC,CAAC;gBACL,CAAC;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,eAAe,GAAG,GAAG,EAAE;QAC3B,OAAO,IAAI,OAAO,CAAc,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC3C,WAAW,CAAC,OAAO,EAAE,CAAC,IAAI,CACxB,CAAC,IAAI,EAAE,EAAE;gBACP,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,EAAE,CAAC;oBAClC,OAAO,GAAG,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC;gBACzD,CAAC;qBAAM,CAAC;oBACN,OAAO,GAAG,CAAC,IAAI,CAAC,OAAsB,CAAC,CAAC;gBAC1C,CAAC;YACH,CAAC,EACD,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CACxD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,oBAAoB,GAAG,GAAkC,EAAE,CAC/D,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;QACpC,6DAA6D;QAC7D,IAAI,IAAU,CAAC;QAEf,IACE,CAAC,uBAAuB,CAAC,WAAW,CAAC,QAAQ,CAAC,mBAAmB,CAAC;YAChE,uBAAuB,CAAC,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CAAC;YACnE,CAAC,YAAY,EAAE,EACf,CAAC;YACD;;;;eAIG;YACH,IAAI,CAAC;gBACH,MAAM,WAAW,CAAC,oBAAoB,EAAE,CAAC;gBACzC,IAAI,GAAG,MAAM,WAAW,CAAC,OAAO,EAAE,CAAC;YACrC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,OAAO,MAAM,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC;YAC9D,CAAC;YAED,OAAO,OAAO,CAAC;gBACb,YAAY,EAAE,KAAK;gBACnB,KAAK,EAAE,IAAI,EAAE,KAAK;aACnB,CAAC,CAAC;QACL,CAAC;QAED,IAAI,uBAAuB,CAAC,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,YAAY,EAAE,EAAE,CAAC;YACjF,IAAI,CAAC;gBACH,IAAI,GAAG,MAAM,WAAW,CAAC,cAAc,EAAE,CAAC;YAC5C,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX;;;mBAGG;gBACH,OAAO,MAAM,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC;YAC9D,CAAC;YAED,IAAI,MAAM,EAAE,CAAC;gBACX,MAAM,CAAC,KAAK,CAAC,kBAAkB,MAAM,kCAAkC,CAAC,CAAC;gBACzE,MAAM,CAAC,QAAQ,CAAC,IAAI,GAAG,MAAM,CAAC;gBAE9B,OAAO,OAAO,CAAC;oBACb,YAAY,EAAE,KAAK;oBACnB,KAAK,EAAE,IAAI,EAAE,KAAK;iBACnB,CAAC,CAAC;YACL,CAAC;YAED,6FAA6F;YAC7F,OAAO,OAAO,CAAC;gBACb,YAAY,EAAE,IAAI;gBAClB,KAAK,EAAE,IAAI,EAAE,KAAK;aACnB,CAAC,CAAC;QACL,CAAC;QAED;;;;WAIG;QACH,OAAO,aAAa,EAAE;aACnB,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;YACd,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,OAAO,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;YACzC,CAAC;iBAAM,CAAC;gBACN,6FAA6F;gBAC7F,OAAO,MAAM,CAAC,IAAI,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC;YAC3D,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,KAAK,EAAE,MAAiB,EAAE,EAAE;YACjC,IAAI,MAAM,CAAC,IAAI,KAAK,aAAa,CAAC,aAAa,EAAE,CAAC;gBAChD;;;;;;;mBAOG;gBACH,MAAM,WAAW,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;gBACvD,OAAO,OAAO,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;YAC1C,CAAC;YAED;;;;eAIG;YACH,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEL,OAAO;QACL,CAAC,EAAE,WAAW;QACd,KAAK;YACH,OAAO,WAAW,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;QAC1D,CAAC;QACD,MAAM;YACJ,OAAO,WAAW,CAAC,eAAe,EAAE,CAAC;QACvC,CAAC;QACD,MAAM;YACJ,OAAO,WAAW,CAAC,YAAY,EAAE,CAAC;QACpC,CAAC;QACD,oBAAoB;QACpB,aAAa,CAAC,GAAG;YACf,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,GAAG,CAAC,UAAU,CACZ,aAAa,EAAE,CAAC,IAAI,CAClB,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,aAAa,EAAE,UAAU,KAAK,EAAE,EAAE,EACxD,GAAG,EAAE,CAAC,SAAS,CAChB,CACF,CAAC;YACJ,CAAC;QACH,CAAC;QACD,KAAK,EAAE,aAAa;QACpB,OAAO,EAAE,eAAe;KACzB,CAAC;AACJ,CAAC"}
|
package/lib/types.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { UserProfile, StateStore } from 'oidc-client-ts';
|
|
2
2
|
/**
|
|
3
3
|
* Available configuration options for the OpenID Connect plugin.
|
|
4
4
|
*/
|
|
@@ -50,7 +50,7 @@ export interface OidcConfig {
|
|
|
50
50
|
* via the responseType. By default, the responseType `code` will
|
|
51
51
|
* get `query` and responseType `token` will get `fragment`.
|
|
52
52
|
*/
|
|
53
|
-
responseMode?:
|
|
53
|
+
responseMode?: 'query' | 'fragment';
|
|
54
54
|
/**
|
|
55
55
|
* The scopes to be used. By default, `openid` is used.
|
|
56
56
|
*/
|
|
@@ -145,7 +145,7 @@ export interface PiralCustomOidcProfile {
|
|
|
145
145
|
/**
|
|
146
146
|
* The defined OIDC profile.
|
|
147
147
|
*/
|
|
148
|
-
export type OidcProfile = PiralCustomOidcProfile &
|
|
148
|
+
export type OidcProfile = PiralCustomOidcProfile & UserProfile;
|
|
149
149
|
export interface OidcRequest {
|
|
150
150
|
/**
|
|
151
151
|
* Sets the headers of the request.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "piral-oidc",
|
|
3
|
-
"version": "1.9.0-beta.
|
|
3
|
+
"version": "1.9.0-beta.8196",
|
|
4
4
|
"description": "Plugin to integrate authentication using OpenID connect in Piral.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"piral",
|
|
@@ -52,10 +52,10 @@
|
|
|
52
52
|
"test": "echo \"Error: run tests from root\" && exit 1"
|
|
53
53
|
},
|
|
54
54
|
"dependencies": {
|
|
55
|
-
"oidc-client": "^
|
|
55
|
+
"oidc-client-ts": "^3"
|
|
56
56
|
},
|
|
57
57
|
"devDependencies": {
|
|
58
|
-
"piral-core": "1.9.0-beta.
|
|
58
|
+
"piral-core": "1.9.0-beta.8196"
|
|
59
59
|
},
|
|
60
|
-
"gitHead": "
|
|
60
|
+
"gitHead": "73f7d0d90884d0b1dc1cc5ed7965f0cb0bc48a20"
|
|
61
61
|
}
|