Skip to content

Adds step-up MFA #23

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
andrew-propelauth merged 1 commit into from
Apr 17, 2025
Merged

Adds step-up MFA #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 17 additions & 19 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
"type": "git",
"url": "https://github.com/PropelAuth/express"
},
"version": "2.1.32",
"version": "2.1.33",
"license": "MIT",
"keywords": [
"auth",
"express",
"user"
],
"dependencies": {
"@propelauth/node": "^2.1.32"
"@propelauth/node": "^2.1.33"
},
"devDependencies": {
"@rollup/plugin-commonjs": "^19.0.0",
Expand Down
55 changes: 18 additions & 37 deletions src/auth.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import {
UnauthorizedException,
UnexpectedException,
User,
UserClass,
UserAndOrgMemberInfo,
UserClass,
} from "@propelauth/node"
import { RequiredOrgInfo } from "@propelauth/node/dist/auth"
import { NextFunction, Request, Response } from "express"
Expand Down Expand Up @@ -37,8 +37,9 @@ export function initAuth(opts: AuthOptions) {
const requireOrgMember = createRequireOrgMemberMiddleware(
auth.validateAccessTokenAndGetUserWithOrgInfo,
auth.validateAccessTokenAndGetUserClass,
debugMode)

debugMode
)

const requireOrgMemberWithMinimumRole = createRequireOrgMemberMiddlewareWithMinimumRole(
auth.validateAccessTokenAndGetUserWithOrgInfoWithMinimumRole,
auth.validateAccessTokenAndGetUserClass,
Expand Down Expand Up @@ -117,6 +118,8 @@ export function initAuth(opts: AuthOptions) {
setSamlIdpMetadata: auth.setSamlIdpMetadata,
samlGoLive: auth.samlGoLive,
deleteSamlConnection: auth.deleteSamlConnection,
verifyStepUpTotpChallenge: auth.verifyStepUpTotpChallenge,
verifyStepUpGrant: auth.verifyStepUpGrant,
}
}

Expand Down Expand Up @@ -148,9 +151,7 @@ function createRequireOrgMemberMiddleware(
authorizationHeader: string | undefined,
requiredOrgInfo: RequriedOrgInfo
) => Promise<UserAndOrgMemberInfo>,
validateAccessTokenAndGetUserClass: (
authorizationHeader: string | undefined,
) => Promise<UserClass>,
validateAccessTokenAndGetUserClass: (authorizationHeader: string | undefined) => Promise<UserClass>,
debugMode: boolean
) {
return function requireOrgMember(args?: RequireOrgMemberArgs) {
Expand All @@ -162,9 +163,7 @@ function createRequireOrgMemberMiddleware(
return validateAccessTokenAndGetUserWithOrgInfo(authorizationHeader, requiredOrgInfo)
},
(authorizationHeader) => {
return validateAccessTokenAndGetUserClass(
authorizationHeader
)
return validateAccessTokenAndGetUserClass(authorizationHeader)
},
debugMode,
orgIdExtractor,
Expand All @@ -179,9 +178,7 @@ function createRequireOrgMemberMiddlewareWithMinimumRole(
requiredOrgInfo: RequriedOrgInfo,
minimumRole: string
) => Promise<UserAndOrgMemberInfo>,
validateAccessTokenAndGetUserClass: (
authorizationHeader: string | undefined,
) => Promise<UserClass>,
validateAccessTokenAndGetUserClass: (authorizationHeader: string | undefined) => Promise<UserClass>,
debugMode: boolean
) {
return function requireOrgMemberWithMinimumRole(args: RequireOrgMemberWithMinimumRoleArgs) {
Expand All @@ -197,9 +194,7 @@ function createRequireOrgMemberMiddlewareWithMinimumRole(
)
},
(authorizationHeader) => {
return validateAccessTokenAndGetUserClass(
authorizationHeader
)
return validateAccessTokenAndGetUserClass(authorizationHeader)
},
debugMode,
orgIdExtractor,
Expand All @@ -214,9 +209,7 @@ function createRequireOrgMemberMiddlewareWithExactRole(
requiredOrgInfo: RequriedOrgInfo,
role: string
) => Promise<UserAndOrgMemberInfo>,
validateAccessTokenAndGetUserClass: (
authorizationHeader: string | undefined,
) => Promise<UserClass>,
validateAccessTokenAndGetUserClass: (authorizationHeader: string | undefined) => Promise<UserClass>,
debugMode: boolean
) {
return function requireOrgMemberWithMinimumRole(args: RequireOrgMemberWithExactRoleArgs) {
Expand All @@ -232,9 +225,7 @@ function createRequireOrgMemberMiddlewareWithExactRole(
)
},
(authorizationHeader) => {
return validateAccessTokenAndGetUserClass(
authorizationHeader
)
return validateAccessTokenAndGetUserClass(authorizationHeader)
},
debugMode,
orgIdExtractor,
Expand All @@ -249,9 +240,7 @@ function createRequireOrgMemberMiddlewareWithPermission(
requiredOrgInfo: RequriedOrgInfo,
permission: string
) => Promise<UserAndOrgMemberInfo>,
validateAccessTokenAndGetUserClass: (
authorizationHeader: string | undefined,
) => Promise<UserClass>,
validateAccessTokenAndGetUserClass: (authorizationHeader: string | undefined) => Promise<UserClass>,
debugMode: boolean
) {
return function requireOrgMemberWithMinimumRole(args: RequireOrgMemberWithPermissionArgs) {
Expand All @@ -267,9 +256,7 @@ function createRequireOrgMemberMiddlewareWithPermission(
)
},
(authorizationHeader) => {
return validateAccessTokenAndGetUserClass(
authorizationHeader
)
return validateAccessTokenAndGetUserClass(authorizationHeader)
},
debugMode,
orgIdExtractor,
Expand All @@ -284,9 +271,7 @@ function createRequireOrgMemberMiddlewareWithAllPermissions(
requiredOrgInfo: RequriedOrgInfo,
permissions: string[]
) => Promise<UserAndOrgMemberInfo>,
validateAccessTokenAndGetUserClass: (
authorizationHeader: string | undefined,
) => Promise<UserClass>,
validateAccessTokenAndGetUserClass: (authorizationHeader: string | undefined) => Promise<UserClass>,
debugMode: boolean
) {
return function requireOrgMemberWithMinimumRole(args: RequireOrgMemberWithAllPermissionsArgs) {
Expand All @@ -302,9 +287,7 @@ function createRequireOrgMemberMiddlewareWithAllPermissions(
)
},
(authorizationHeader) => {
return validateAccessTokenAndGetUserClass(
authorizationHeader
)
return validateAccessTokenAndGetUserClass(authorizationHeader)
},
debugMode,
orgIdExtractor,
Expand All @@ -318,12 +301,10 @@ function requireOrgMemberGenericMiddleware(
authorizationHeader: string | undefined,
requiredOrgInfo: RequiredOrgInfo
) => Promise<UserAndOrgMemberInfo>,
validateAccessTokenAndGetUserClass: (
authorizationHeader: string | undefined,
) => Promise<UserClass>,
validateAccessTokenAndGetUserClass: (authorizationHeader: string | undefined) => Promise<UserClass>,
debugMode: boolean,
orgIdExtractor?: (req: Request) => string,
orgNameExtractor?: (req: Request) => string,
orgNameExtractor?: (req: Request) => string
) {
return async function (req: Request, res: Response, next: NextFunction) {
let requiredOrgInfo: RequiredOrgInfo
Expand Down
22 changes: 16 additions & 6 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,18 @@ export {
ChangeUserRoleInOrgException,
CreateOrgException,
CreateUserException,
FeatureGatedException,
ForbiddenException,
IncorrectMfaCodeException,
InvalidRequestFieldsException,
MagicLinkCreationException,
MfaNotEnabledException,
MigrateUserException,
MigrateUserPasswordException,
Org,
OrgIdToOrgMemberInfo,
RemoveUserFromOrgException,
RevokePendingOrgInviteException,
toOrgIdToOrgMemberInfo,
toUser,
UnauthorizedException,
Expand Down Expand Up @@ -53,6 +58,8 @@ export type {
CreateUserRequest,
CustomRoleMapping,
CustomRoleMappings,
FetchSamlSpMetadataResponse,
IdpProvider,
InternalOrgMemberInfo,
InternalUser,
InviteUserToOrgRequest,
Expand All @@ -65,24 +72,27 @@ export type {
OrgQueryResponse,
PersonalApiKeyValidation,
RemoveUserFromOrgRequest,
RevokePendingOrgInviteRequest,
SamlLoginProvider,
SetSamlIdpMetadataRequest,
SocialLoginProvider,
StepUpMfaGrantType,
StepUpMfaVerifyGrantResponse,
StepUpMfaVerifyTotpResponse,
TokenVerificationMetadata,
UpdateOrgRequest,
UpdateUserEmailRequest,
UpdateUserMetadataRequest,
UpdateUserPasswordRequest,
UserProperties,
UserInOrgMetadata,
UsersInOrgPagedResponse,
UserProperties,
UserSignupQueryParams,
UsersInOrgPagedResponse,
UsersInOrgQuery,
UsersPagedResponse,
UsersQuery,
RevokePendingOrgInviteRequest,
FetchSamlSpMetadataResponse,
SetSamlIdpMetadataRequest,
IdpProvider,
VerifyStepUpGrantRequest,
VerifyTotpChallengeRequest,
} from "@propelauth/node"
export { AuthOptions, initAuth } from "./auth"
export type { RequireOrgMemberArgs } from "./auth"
Expand Down