npmpackage.info

Gathering detailed insights and metrics for angular-auth-oidc-client

Other packages similar to angular-auth-oidc-client

@aws-sdk/client-sso-oidc

3.699.0

AWS SDK for JavaScript Sso Oidc Client for Node.js, Browser and React Native

angular-oauth2-oidc

17.0.2

Support for OAuth 2 and OpenId Connect (OIDC) in Angular. Already prepared for the upcoming OAuth 2.1.

react-oidc-context

3.2.0

OpenID Connect & OAuth2 authentication using react context api as state management

angular-oauth2-oidc-jwks

17.0.2

Support for OAuth 2 and OpenId Connect (OIDC) in Angular. Already prepared for the upcoming OAuth 2.1.

Gathering detailed insights and metrics for angular-auth-oidc-client

angular-auth-oidc-client

npm package for OpenID Connect, OAuth Code Flow with PKCE, Refresh tokens, Implicit Flow

18.0.2

1,153

MIT

TypeScript

8,837,986 5.4

Installations

npm install angular-auth-oidc-client

Pull Requests

Open

3

Total

678

Closed

97

Merged

578

Issues

Open

207

Total

1,367

Closed

1,160

Releases

131

18.0.2

Published on 12 Oct 2024

18.0.1

Published on 20 Jun 2024

18.0.0

Published on 07 Jun 2024

17.1.0

Published on 31 May 2024

17.0.0

Published on 03 Feb 2024

Release 16.0.1

release_16_0_1

Published on 27 Aug 2023

View all 131 releases

Developer

damienbod

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

No

Node Version

20.11.1

NPM Version

10.5.0 Statistics

1,153 Stars

4,229 Commits

435 Forks

36 Watching

10 Branches

91 Contributors

Updated on 25 Nov 2024

Languages

TypeScript (86.91%)

JavaScript (10.21%)

HTML (2.61%)

CSS (0.28%)

Total Downloads

Cumulative downloads

Total Downloads

8,837,986

Last day

-0.5%

14,753

Compared to previous day

Last week

-0.9%

70,811

Compared to previous week

Last month

3.9%

303,808

Compared to previous month

Last year

45.3%

3,050,037

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

tslib rfc4648

Peer Dependencies

rxjs @angular/core @angular/common @angular/router

Versions

Angular Lib for OpenID Connect & OAuth2

Secure your Angular app using the latest standards for OpenID Connect & OAuth2. Provides support for token refresh, all modern OIDC Identity Providers and more.

Acknowledgements

This library is certified by OpenID Foundation. (RP Implicit and Config RP)

Features

Code samples for most of the common use cases
Supports schematics via ng add support
Supports all modern OIDC identity providers
Supports OpenID Connect Code Flow with PKCE
Supports Code Flow PKCE with Refresh tokens
Supports OpenID Connect Implicit Flow
Supports OpenID Connect Session Management 1.0
Supports RFC7009 - OAuth 2.0 Token Revocation
Supports RFC7636 - Proof Key for Code Exchange (PKCE)
Supports OAuth 2.0 Pushed authorisation requests (PAR) draft
Semantic releases
Github actions
Modern coding guidelines with prettier, husky
Up to date documentation
Implements OIDC validation as specified, complete client side validation for REQUIRED features
Supports authentication using redirect or popup

Installation

Ng Add

You can use the schematics and ng add the library.

1ng add angular-auth-oidc-client

And answer the questions. A module will be created which encapsulates your configuration.

angular-auth-oidc-client schematics

Npm / Yarn

Navigate to the level of your package.json and type

1 npm install angular-auth-oidc-client

or with yarn

1 yarn add angular-auth-oidc-client

Documentation

Read the docs here

Samples

Explore the Samples here

Quickstart

For the example of the Code Flow. For further examples please check the Samples Section.

If you have done the installation with the schematics, these modules and files should be available already!

Configuration

Import the AuthModule in your module.

1import { NgModule } from '@angular/core';
2import { AuthModule, LogLevel } from 'angular-auth-oidc-client';
3// ...
4
5@NgModule({
6  // ...
7  imports: [
8    // ...
9    AuthModule.forRoot({
10      config: {
11        authority: '<your authority address here>',
12        redirectUrl: window.location.origin,
13        postLogoutRedirectUri: window.location.origin,
14        clientId: '<your clientId>',
15        scope: 'openid profile email offline_access',
16        responseType: 'code',
17        silentRenew: true,
18        useRefreshToken: true,
19        logLevel: LogLevel.Debug,
20      },
21    }),
22  ],
23  // ...
24})
25export class AppModule {}

And call the method checkAuth() from your app.component.ts. The method checkAuth() is needed to process the redirect from your Security Token Service and set the correct states. This method must be used to ensure the correct functioning of the library.

1import { Component, OnInit, inject } from '@angular/core';
2import { OidcSecurityService } from 'angular-auth-oidc-client';
3
4@Component({
5  /*...*/
6})
7export class AppComponent implements OnInit {
8  private readonly oidcSecurityService = inject(OidcSecurityService);
9
10  ngOnInit() {
11    this.oidcSecurityService
12      .checkAuth()
13      .subscribe((loginResponse: LoginResponse) => {
14        const { isAuthenticated, userData, accessToken, idToken, configId } =
15          loginResponse;
16
17        /*...*/
18      });
19  }
20
21  login() {
22    this.oidcSecurityService.authorize();
23  }
24
25  logout() {
26    this.oidcSecurityService
27      .logoff()
28      .subscribe((result) => console.log(result));
29  }
30}

Using the access token

You can get the access token by calling the method getAccessToken() on the OidcSecurityService

1const token = this.oidcSecurityService.getAccessToken().subscribe(...);

And then you can use it in the HttpHeaders

1import { HttpHeaders } from '@angular/common/http';
2
3const token = this.oidcSecurityServices.getAccessToken().subscribe((token) => {
4  const httpOptions = {
5    headers: new HttpHeaders({
6      Authorization: 'Bearer ' + token,
7    }),
8  };
9});

You can use the built in interceptor to add the accesstokens to your request

1AuthModule.forRoot({
2  config: {
3    // ...
4    secureRoutes: ['https://my-secure-url.com/', 'https://my-second-secure-url.com/'],
5  },
6}),

1 providers: [
2    { provide: HTTP_INTERCEPTORS, useClass: AuthInterceptor, multi: true },
3  ],

Versions

Current Version is Version 18.x

License

MIT

Authors

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:109: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:114: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:149: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:154: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:189: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:194: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:233: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:238: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/build.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/build.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-docs.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/deploy-docs.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-docs.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/deploy-docs.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-docs.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/deploy-docs.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-docs.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/damienbod/angular-auth-oidc-client/deploy-docs.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:81
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:92
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:121
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:132
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:161
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:172
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:201
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:211
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:216
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:245
Warn: npmCommand not pinned by hash: .github/workflows/build.yml:256
Warn: npmCommand not pinned by hash: .github/workflows/deploy-docs.yml:29
Warn: npmCommand not pinned by hash: .github/workflows/deploy-docs.yml:32
Info: 0 out of 15 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 4 third-party GitHubAction dependencies pinned
Info: 1 out of 14 npmCommand dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

5.4

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More