Skip to content

[passport-jwt] fix: Library agnostic to Express #67897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
weswigham merged 5 commits into from
Jan 2, 2024
Merged

[passport-jwt] fix: Library agnostic to Express #67897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dea568f
express agnostic
QuentinLemCode Dec 15, 2023
e3de512
fix version to mirror the passport-jwt one
QuentinLemCode Dec 15, 2023
1021412
fix generic and add test
QuentinLemCode Dec 15, 2023
c8be52c
fix version
QuentinLemCode Dec 15, 2023
5b8fc84
format
QuentinLemCode Dec 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions types/passport-jwt/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import * as express from "express";
import { VerifyOptions } from "jsonwebtoken";
import { Strategy as PassportStrategy } from "passport-strategy";

Expand All @@ -25,19 +24,19 @@ export interface VerifyCallback {
}

export interface VerifyCallbackWithRequest {
(req: express.Request, payload: any, done: VerifiedCallback): void;
(req: Request, payload: any, done: VerifiedCallback): void;
}

export interface VerifiedCallback {
(error: any, user?: Express.User | false, info?: any): void;
}

export interface JwtFromRequestFunction {
(req: express.Request): string | null;
export interface JwtFromRequestFunction<T = Request> {
(req: T): string | null;
}

export interface SecretOrKeyProvider {
(request: express.Request, rawJwtToken: any, done: (err: any, secretOrKey?: string | Buffer) => void): void;
(request: Request, rawJwtToken: any, done: (err: any, secretOrKey?: string | Buffer) => void): void;
}

export declare namespace ExtractJwt {
Expand All @@ -46,6 +45,6 @@ export declare namespace ExtractJwt {
export function fromUrlQueryParameter(param_name: string): JwtFromRequestFunction;
export function fromAuthHeaderWithScheme(auth_scheme: string): JwtFromRequestFunction;
export function fromAuthHeader(): JwtFromRequestFunction;
export function fromExtractors(extractors: JwtFromRequestFunction[]): JwtFromRequestFunction;
export function fromExtractors(extractors: Array<JwtFromRequestFunction<any>>): JwtFromRequestFunction;
export function fromAuthHeaderAsBearerToken(): JwtFromRequestFunction;
}
3 changes: 1 addition & 2 deletions types/passport-jwt/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
{
"private": true,
"name": "@types/passport-jwt",
"version": "3.0.9999",
"version": "4.0.9999",
"projects": [
"https://github.com/themikenicholson/passport-jwt"
],
"dependencies": {
"@types/express": "*",
"@types/jsonwebtoken": "*",
"@types/passport-strategy": "*"
},
Expand Down
10 changes: 7 additions & 3 deletions types/passport-jwt/passport-jwt-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
/// <reference types="passport" />
"use strict";

import { Request } from "express";
import * as passport from "passport";
import { ExtractJwt, Strategy as JwtStrategy, StrategyOptions } from "passport-jwt";
import { ExtractJwt, JwtFromRequestFunction, Strategy as JwtStrategy, StrategyOptions } from "passport-jwt";

let opts: StrategyOptions = {
jwtFromRequest: ExtractJwt.fromAuthHeader(),
Expand All @@ -29,6 +28,10 @@ passport.use(
}),
);

const jwtFromTokenInRequest: JwtFromRequestFunction<{ token: string }> = (req: { token: string }) => {
return req.token;
};

opts.jwtFromRequest = ExtractJwt.fromHeader("x-api-key");
opts.jwtFromRequest = ExtractJwt.fromBodyField("field_name");
opts.jwtFromRequest = ExtractJwt.fromUrlQueryParameter("param_name");
Expand All @@ -37,10 +40,11 @@ opts.jwtFromRequest = ExtractJwt.fromExtractors([
ExtractJwt.fromHeader("x-api-key"),
ExtractJwt.fromBodyField("field_name"),
ExtractJwt.fromUrlQueryParameter("param_name"),
jwtFromTokenInRequest,
]);
opts.jwtFromRequest = ExtractJwt.fromAuthHeaderAsBearerToken();
opts.jwtFromRequest = (req: Request) => {
return req.query.token as string;
return req.headers.get("token") as string;
};
opts.secretOrKey = new Buffer("secret");
opts.secretOrKeyProvider = (request, rawJwtToken, done) => done(null, new Buffer("secret"));
Expand Down