You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+27-1Lines changed: 27 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# angular-simple-oidc
2
2
3
-
An Angular (currently 8+, lower versions could be supported) library for the [Open Id Connect Protocol](https://openid.net/specs/openid-connect-core-1_0.html) implementing:
3
+
An Angular library for the [Open Id Connect Protocol](https://openid.net/specs/openid-connect-core-1_0.html) implementing:
4
4
5
5
* Discovery Document
6
6
* Code Flow
@@ -9,6 +9,21 @@ An Angular (currently 8+, lower versions could be supported) library for the [Op
9
9
* Session Checks
10
10
* Code Flow in popup
11
11
12
+
## Angular Versioning
13
+
14
+
For Angular 8, use the `v8.x` latest release.
15
+
16
+
For Angular 9, use the `v9.x` latest release.
17
+
18
+
Using `master` branch is not recommended.
19
+
20
+
## Disclaimer
21
+
22
+
I am not a security expert. I've followed my best the RFCs, please I encourage you
23
+
to review my work and report issues if you suspect something may be wrong.
24
+
25
+
**Use at your own risk**.
26
+
12
27
## Motivation
13
28
14
29
Why another OIDC library?
@@ -34,6 +49,14 @@ Install from NPM
34
49
yarn add angular-simple-oidc
35
50
```
36
51
52
+
### Configuring your Identity Provider
53
+
54
+
Authorization Code Flow with PKCE will be used, so your Identity Provider (idp)
55
+
must support this. Your idp may require a client secret as well.
56
+
57
+
The redirect URI, by default will be `http://yourapp.example.com/oidc-token-callback`.
58
+
You can change the path by configuring the `tokenCallbackRoute`.
59
+
37
60
### Static Configuration
38
61
39
62
You will then need to supply the configuration for OIDC.
This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 8.1.2.
3
+
Please, check the [whole readme at GitHub](https://github.com/leonardochaia/angular-simple-oidc#angular-simple-oidc)
4
4
5
-
## Code scaffolding
6
-
7
-
Run `ng generate component component-name --project angular-simple-oidc` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project angular-simple-oidc`.
8
-
> Note: Don't forget to add `--project angular-simple-oidc` or else it will be added to the default project in your `angular.json` file.
9
-
10
-
## Build
11
-
12
-
Run `ng build angular-simple-oidc` to build the project. The build artifacts will be stored in the `dist/` directory.
13
-
14
-
## Publishing
15
-
16
-
After building your library with `ng build angular-simple-oidc`, go to the dist folder `cd dist/angular-simple-oidc` and run `npm publish`.
17
-
18
-
## Running unit tests
19
-
20
-
Run `ng test angular-simple-oidc` to execute the unit tests via [Karma](https://karma-runner.github.io).
21
-
22
-
## Further help
23
-
24
-
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
0 commit comments