Skip to content
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

Feature/sprind 116 #169

Merged
merged 14 commits into from
Jan 14, 2025
Merged

Feature/sprind 116 #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
2cc45e7
chore: Added federation_entity metadata to siop/oid4vp and oid4vci
zoemaas Nov 18, 2024
e9fb7cc
chore: Added openid_credential_verifier into the client registration …
zoemaas Nov 20, 2024
7089350
chore: Added openid_credential_issuer. oauth_authorization_server and…
zoemaas Nov 20, 2024
60f5f3c
Merge branch 'develop' of https://github.com/Sphereon-Opensource/OID4…
zoemaas Nov 22, 2024
2f91ee2
chore: Resolve the OID Federation metadata oid4vp
zoemaas Nov 25, 2024
123ee3e
refactor: Refactored trust chain resolution
zoemaas Nov 25, 2024
4e483a7
refactor: Removed openid-federation-* dependencies
zoemaas Nov 25, 2024
c253784
Merge branch 'develop' of https://github.com/Sphereon-Opensource/OID4…
zoemaas Nov 25, 2024
089be8a
refactor: Rolled back the changes, metadata is already present in the…
zoemaas Nov 25, 2024
38d68ab
refactor: Removed the OIDF types from the library
zoemaas Nov 25, 2024
4060fe7
refactor: Added the OIDF client and check to the OID4VCI library
zoemaas Nov 26, 2024
e04c3d1
refactor: Removed the OIDF library and added the client metadata to t…
zoemaas Nov 26, 2024
3817197
refactor: Updated pnpm-lock.yaml
zoemaas Nov 26, 2024
642c60b
Merge branch 'develop' of https://github.com/Sphereon-Opensource/OID4…
zoemaas Jan 14, 2025
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
6 changes: 6 additions & 0 deletions packages/client/lib/OpenID4VCIClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ export class OpenID4VCIClient {
pkce,
authorizationRequest,
createAuthorizationRequestURL,
endpointMetadata
}: {
credentialIssuer: string;
kid?: string;
Expand All @@ -139,6 +140,7 @@ export class OpenID4VCIClient {
createAuthorizationRequestURL?: boolean;
authorizationRequest?: AuthorizationRequestOpts; // Can be provided here, or when manually calling createAuthorizationUrl
pkce?: PKCEOpts;
endpointMetadata?: EndpointMetadataResult
}) {
const client = new OpenID4VCIClient({
kid,
Expand All @@ -147,6 +149,7 @@ export class OpenID4VCIClient {
credentialIssuer,
pkce,
authorizationRequest,
endpointMetadata
});
if (retrieveServerMetadata === undefined || retrieveServerMetadata) {
await client.retrieveServerMetadata();
Expand All @@ -173,6 +176,7 @@ export class OpenID4VCIClient {
createAuthorizationRequestURL,
authorizationRequest,
resolveOfferUri,
endpointMetadata
}: {
uri: string;
kid?: string;
Expand All @@ -183,6 +187,7 @@ export class OpenID4VCIClient {
pkce?: PKCEOpts;
clientId?: string;
authorizationRequest?: AuthorizationRequestOpts; // Can be provided here, or when manually calling createAuthorizationUrl
endpointMetadata?: EndpointMetadataResult
}): Promise<OpenID4VCIClient> {
const credentialOfferClient = await CredentialOfferClient.fromURI(uri, { resolve: resolveOfferUri });
const client = new OpenID4VCIClient({
Expand All @@ -192,6 +197,7 @@ export class OpenID4VCIClient {
clientId: clientId ?? authorizationRequest?.clientId ?? credentialOfferClient.clientId,
pkce,
authorizationRequest,
endpointMetadata
});

if (retrieveServerMetadata === undefined || retrieveServerMetadata) {
Expand Down
16 changes: 11 additions & 5 deletions packages/siop-oid4vp/lib/authorization-request/URI.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,16 +235,22 @@ export class URI implements AuthorizationRequestURI {
return { scheme, authorizationRequestPayload }
}

public static async parseAndResolve(uri: string) {
public static async parseAndResolve(uri: string, rpRegistrationMetadata?: RPRegistrationMetadataPayload) {
Copy link

@ronal2do ronal2do Jan 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make make it more functional, and split the logic on it for something like

Suggested change
public static async parseAndResolve(uri: string, rpRegistrationMetadata?: RPRegistrationMetadataPayload) {
/**
* Parses the URI and resolves the registration metadata
* @param uri
* @param rpRegistrationMetadata
* @returns Promise<{scheme: string, authorizationRequestPayload: AuthorizationRequestPayload, requestObjectJwt: RequestObjectJwt, registrationMetadata: RPRegistrationMetadataPayload}>
*/
public static async parseAndResolve(uri: string, rpRegistrationMetadata?: RPRegistrationMetadataPayload) {
if (!uri) {
throw Error(SIOPErrors.BAD_PARAMS)
}
const { authorizationRequestPayload, scheme } = this.parse(uri)
const requestObjectJwt = await fetchByReferenceOrUseByValue(
authorizationRequestPayload.client_metadata_uri,
authorizationRequestPayload.client_metadata
)
const registrationMetadata = await this.resolveRegistrationMetadata(
rpRegistrationMetadata,
authorizationRequestPayload,
)
assertValidRPRegistrationMedataPayload(registrationMetadata)
return { scheme, authorizationRequestPayload, requestObjectJwt, registrationMetadata }
}
/**
* Resolves the registration metadata
* @param providedMetadata
* @param authPayload
* @returns Promise<RPRegistrationMetadataPayload>
*/
private static async resolveRegistrationMetadata(
providedMetadata?: RPRegistrationMetadataPayload,
authPayload?: AuthorizationRequestPayload
): Promise<RPRegistrationMetadataPayload> {
if (providedMetadata) {
return providedMetadata
}
return await fetchByReferenceOrUseByValue(
authPayload?.['client_metadata_uri'] ?? authPayload?.['registration_uri'],
authPayload?.['client_metadata'] ?? authPayload?.['registration']
)
}

if (!uri) {
throw Error(SIOPErrors.BAD_PARAMS)
}
const { authorizationRequestPayload, scheme } = this.parse(uri)

const requestObjectJwt = await fetchByReferenceOrUseByValue(authorizationRequestPayload.request_uri, authorizationRequestPayload.request, true)
const registrationMetadata: RPRegistrationMetadataPayload = await fetchByReferenceOrUseByValue(
authorizationRequestPayload['client_metadata_uri'] ?? authorizationRequestPayload['registration_uri'],
authorizationRequestPayload['client_metadata'] ?? authorizationRequestPayload['registration'],
)
let registrationMetadata: RPRegistrationMetadataPayload
if (rpRegistrationMetadata !== undefined && rpRegistrationMetadata !== null) {
registrationMetadata = rpRegistrationMetadata
} else {
registrationMetadata = await fetchByReferenceOrUseByValue(
authorizationRequestPayload['client_metadata_uri'] ?? authorizationRequestPayload['registration_uri'],
authorizationRequestPayload['client_metadata'] ?? authorizationRequestPayload['registration'],
)
}
assertValidRPRegistrationMedataPayload(registrationMetadata)
return { scheme, authorizationRequestPayload, requestObjectJwt, registrationMetadata }
}
Expand Down
7 changes: 4 additions & 3 deletions packages/siop-oid4vp/lib/op/OP.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import {
RegisterEventListener,
RequestObjectPayload,
ResponseIss,
ResponseMode,
ResponseMode, RPRegistrationMetadataPayload,
SIOPErrors,
SupportedVersion,
UrlEncodingFormat,
Expand Down Expand Up @@ -275,9 +275,10 @@ export class OP {
* Create an Authentication Request Payload from a URI string
*
* @param encodedUri
* @param rpRegistrationMetadata
*/
public async parseAuthorizationRequestURI(encodedUri: string): Promise<ParsedAuthorizationRequestURI> {
const { scheme, requestObjectJwt, authorizationRequestPayload, registrationMetadata } = await URI.parseAndResolve(encodedUri)
public async parseAuthorizationRequestURI(encodedUri: string, rpRegistrationMetadata?: RPRegistrationMetadataPayload): Promise<ParsedAuthorizationRequestURI> {
const { scheme, requestObjectJwt, authorizationRequestPayload, registrationMetadata } = await URI.parseAndResolve(encodedUri, rpRegistrationMetadata)

return {
encodedUri,
Expand Down
20 changes: 15 additions & 5 deletions packages/siop-oid4vp/lib/types/SIOP.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
// noinspection JSUnusedGlobalSymbols
import { JarmClientMetadata } from '@sphereon/jarm'
import { DynamicRegistrationClientMetadata, JWKS, SigningAlgo } from '@sphereon/oid4vc-common'
import {
DynamicRegistrationClientMetadata,
JWKS,
SigningAlgo
} from '@sphereon/oid4vc-common'
import { Format, PresentationDefinitionV1, PresentationDefinitionV2 } from '@sphereon/pex-models'
import {
AdditionalClaims,
Expand All @@ -11,22 +15,28 @@ import {
PresentationSubmission,
W3CVerifiableCredential,
W3CVerifiablePresentation,
WrappedVerifiablePresentation,
WrappedVerifiablePresentation
} from '@sphereon/ssi-types'

import { AuthorizationRequest, CreateAuthorizationRequestOpts, PropertyTargets, VerifyAuthorizationRequestOpts } from '../authorization-request'
import {
AuthorizationRequest,
CreateAuthorizationRequestOpts,
PropertyTargets,
VerifyAuthorizationRequestOpts
} from '../authorization-request'
import {
AuthorizationResponse,
AuthorizationResponseOpts,
PresentationDefinitionWithLocation,
PresentationVerificationCallback,
VerifyAuthorizationResponseOpts,
VerifyAuthorizationResponseOpts
} from '../authorization-response'
import { JwksMetadataParams } from '../helpers/ExtractJwks'
import { JwksMetadataParams } from '../helpers'
import { RequestObject, RequestObjectOpts } from '../request-object'
import { IRPSessionManager } from '../rp'

import { JWTPayload, VerifiedJWT } from './index'

export const DEFAULT_EXPIRATION_TIME = 10 * 60

// https://openid.net/specs/openid-connect-core-1_0.html#RequestObject
Expand Down
Loading