Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
nest-oidc-provider
Advanced tools
Readme
oidc-provider module for Nest framework (node.js)
$ npm i --save nest-oidc-provider oidc-provider
OR
$ yarn add nest-oidc-provider oidc-provider
@Module({
imports: [
OidcModule.forRoot({
issuer: 'http://localhost:3000',
path: '/oidc',
oidc: ... // oidc-provider configuration
})
],
})
export class AppModule {}
You can pass a factory
function to customize the provider instantiation.
@Module({
imports: [
OidcModule.forRoot({
issuer: 'http://localhost:3000',
path: '/oidc',
factory: (issuer, config) => {
const provider = new oidc.Provider(issuer, config);
provider.on('server_error', (ctx, err) => {...})
return provider;
},
oidc: ... // oidc-provider configuration
})
],
})
export class AppModule {}
You can set the proxy
option to true
to trust TLS offloading proxies.
For more info visit the oidc-provider
documentation: Trusting TLS offloading proxies
@Module({
imports: [
OidcModule.forRoot({
issuer: 'http://localhost:3000',
path: '/oidc',
proxy: true, // <= trust TLS offloading proxies
oidc: {...}
})
],
})
export class AppModule {}
useFactory
@Module({
imports: [
OidcModule.forRootAsync({
imports: [ConfigModule],
useFactory: async (configService: ConfigService) => ({
issuer: configService.get<string>('ISSUER'),
path: configService.get<string>('OIDC_PATH'),
oidc: ... // oidc-provider configuration
}),
inject: [ConfigService],
}),
],
})
export class AppModule {}
useClass
@Module({
imports: [
OidcModule.forRootAsync({
useClass: OidcConfigService,
}),
],
})
export class AppModule {}
Note that in this example, the OidcConfigService
has to implement the OidcModuleOptionsFactory
interface, as shown below.
@Injectable()
export class OidcConfigService implements OidcModuleOptionsFactory {
constructor(private readonly @InjectConnection() conn: Connection) {}
createModuleOptions(): OidcModuleOptions {
return {
issuer: 'http://localhost:3001',
path: '/oidc',
oidc: ..., // oidc-provider configuration
};
}
createAdapterFactory?(): AdapterFactory {
return (modelName: string) => new MyAdapter(modelName, this.conn);
}
}
You can omit the Adapter
option of oidc-provider configuration if you implement the createAdapterFactory
method.
useExisting
@Module({
imports: [
OidcModule.forRootAsync({
imports: [OidcConfigModule],
useExisting: OidcConfigService,
}),
],
})
export class AppModule {}
@Oidc.Interaction()
Returns an instance of InteractionHelper
class.
@Get(':uid')
@Render('login')
async login(
@Oidc.Interaction() interaction: InteractionHelper
) {
const { prompt, params, uid } = await interaction.details();
const client = await this.provider.Client.find(params.client_id as string);
return { prompt, client, params, uid, ...};
}
The InteractionHelper
class is just a helper that omits the req
and res
parameters from the existing interaction methods in oidc-provider
.
interface InteractionHelper {
details(): Promise<InteractionDetails>;
finished(
result: InteractionResults,
options?: { mergeWithLastSubmission?: boolean },
): Promise<void>;
result(
result: InteractionResults,
options?: { mergeWithLastSubmission?: boolean },
): Promise<string>;
}
@Oidc.Context()
Returns an instance of KoaContextWithOIDC
.
@Get()
async index(@Oidc.Context() ctx: KoaContextWithOIDC) {
const { oidc: { provider } } = ctx;
const session = await provider.Session.get(ctx);
//...
}
A complete example can be found in the example directory.
You are welcome to contribute to this project, just open a PR.
See CHANGELOG for more information.
This project is MIT licensed.
FAQs
oidc-provider module for Nest framework (node.js)
The npm package nest-oidc-provider receives a total of 134 weekly downloads. As such, nest-oidc-provider popularity was classified as not popular.
We found that nest-oidc-provider demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.