@connectid-tools/rp-nodejs-sdk 4.2.1 → 5.0.0

package/src/relying-party-client-sdk.js

@@ -0,0 +1,150 @@
+import { getCertificate } from './utils/cert-utils.js';
+import { getLogger } from './logger.js';
+import ParticipantFilters from './filter/participant-filters.js';
+import { illegalPurposeChars, isValidCertificate, validatePurpose } from './validator.js';
+import { CryptoLoader } from './crypto/crypto-loader.js';
+import { JwtHelper } from './crypto/jwt-helper.js';
+import { HttpClientFactory } from './http/http-client-factory.js';
+import { ParticipantsEndpoint } from './endpoints/participants-endpoint.js';
+import { PushedAuthorisationRequestEndpoint } from './endpoints/pushed-authorisation-request-endpoint.js';
+import { RetrieveTokenEndpoint } from './endpoints/retrieve-token-endpoint.js';
+import { UserInfoEndpoint } from './endpoints/userinfo-endpoint.js';
+export default class RelyingPartyClientSdk {
+    constructor(config) {
+        this.purpose = 'verifying your identity';
+        this.config = config;
+        // Validate certificates
+        if (!isValidCertificate(this.config.data.transport_key, this.config.data.transport_key_content)) {
+            throw new Error('Either transport_key or transport_key_content must be provided');
+        }
+        if (!isValidCertificate(this.config.data.transport_pem, this.config.data.transport_pem_content)) {
+            throw new Error('Either transport_pem or transport_pem_content must be provided');
+        }
+        if (!isValidCertificate(this.config.data.signing_key, this.config.data.signing_key_content)) {
+            throw new Error('Either signing_key or signing_key_content must be provided');
+        }
+        if (!isValidCertificate(this.config.data.ca_pem, this.config.data.ca_pem_content)) {
+            throw new Error('Either ca_pem or ca_pem_content must be provided');
+        }
+        this.logger = getLogger(this.config.data.log_level);
+        this.logger.info(`Creating RelyingPartyClientSdk - version ${process.env.SDK_VERSION}`);
+        // Validate and set purpose
+        if (this.config.data.purpose) {
+            const purposeValidation = validatePurpose(this.config.data.purpose);
+            if (purposeValidation === 'INVALID_LENGTH') {
+                this.logger.warn('Purpose must be between 3 and 300 characters');
+                throw new Error(`Invalid purpose supplied in config: ${this.config.data.purpose}`);
+            }
+            if (purposeValidation === 'INVALID_CHARACTERS') {
+                this.logger.warn(`Purpose cannot contain any of the following characters: ${illegalPurposeChars.join(',')}, purpose supplied: [${this.config.data.purpose}]`);
+                throw new Error(`Invalid purpose supplied in config: ${this.config.data.purpose}`);
+            }
+            this.purpose = this.config.data.purpose;
+            this.logger.info(`Using default purpose supplied in config: ${this.purpose}`);
+        }
+        else {
+            this.logger.info(`Using built-in default purpose: ${this.purpose}`);
+        }
+        // Log filtering configuration
+        if (this.config.data.include_uncertified_participants) {
+            this.logger.info('Identity provider list will not be filtered as include_uncertified_participants=true');
+        }
+        else {
+            if (this.config.data.required_claims) {
+                this.logger.info(`Identity provider list will be filtered for participants that support the following claims: ${JSON.stringify(this.config.data.required_claims)}`);
+            }
+            if (this.config.data.required_participant_certifications) {
+                this.logger.info(`Identity provider list will be filtered for participants that support the following certifications: ${JSON.stringify(this.config.data.required_participant_certifications)}`);
+            }
+        }
+        // Log certificate source
+        this.logger.info(`Using ${this.config.data.transport_key_content ? 'transport_key_content' : 'transport_key'} config prop`);
+        this.logger.info(`Using ${this.config.data.transport_pem_content ? 'transport_pem_content' : 'transport_pem'} config prop`);
+        this.logger.info(`Using ${this.config.data.ca_pem_content ? 'ca_pem_content' : 'ca_pem'} config prop`);
+        this.logger.info(`Using ${this.config.data.signing_key_content ? 'signing_key_content' : 'signing_key'} config prop`);
+        // Initialize crypto
+        const signingKeyObject = CryptoLoader.loadPrivateKey(getCertificate(this.config.data.signing_key, this.config.data.signing_key_content));
+        // Initialize JWT helper
+        this.jwtHelper = new JwtHelper(signingKeyObject, this.config.data.signing_kid, this.config.data.client_id);
+        // Initialize HTTP client
+        this.httpClient = HttpClientFactory.createClient({
+            transportKey: getCertificate(this.config.data.transport_key, this.config.data.transport_key_content),
+            transportPem: getCertificate(this.config.data.transport_pem, this.config.data.transport_pem_content),
+            caPem: getCertificate(this.config.data.ca_pem, this.config.data.ca_pem_content),
+            clientId: this.config.data.client_id,
+        });
+        // Initialize endpoints
+        this.participantsEndpoint = new ParticipantsEndpoint(this.config, new ParticipantFilters(), this.httpClient, this.logger, () => this.getCurrentDate());
+        this.pushedAuthorisationRequestEndpoint = new PushedAuthorisationRequestEndpoint(this.config, this.httpClient, this.jwtHelper, this.logger, this.participantsEndpoint);
+        this.retrieveTokenEndpoint = new RetrieveTokenEndpoint(this.config, this.httpClient, this.jwtHelper, this.logger, this.participantsEndpoint);
+        this.userInfoEndpoint = new UserInfoEndpoint(this.httpClient, this.logger, this.config.data.client_id, this.participantsEndpoint);
+    }
+    /**
+     * Get the list of participating identity providers within the scheme.
+     *
+     * Applies filtering based on SDK configuration.
+     *
+     * @returns List of participants
+     */
+    async getParticipants() {
+        return this.participantsEndpoint.getParticipants();
+    }
+    /**
+     * Get the list of fallback provider participants.
+     *
+     * @returns List of fallback provider participants
+     */
+    async getFallbackProviderParticipants() {
+        return this.participantsEndpoint.getFallbackProviderParticipants();
+    }
+    /**
+     * Sends a Pushed Authorization Request (PAR).
+     *
+     * @param authServerId - Authorization server ID
+     * @param essentialClaims - Claims that must be provided
+     * @param voluntaryClaims - Claims that are optional
+     * @param purpose - Purpose string for data sharing
+     * @returns Object containing authorization URL and PKCE parameters
+     */
+    async sendPushedAuthorisationRequest(authServerId, essentialClaims, voluntaryClaims = [], purpose = this.purpose) {
+        const { authUrl, codeVerifier, state, nonce, xFapiInteractionId } = await this.pushedAuthorisationRequestEndpoint.sendPushedAuthorisationRequest(authServerId, essentialClaims, voluntaryClaims, purpose);
+        return {
+            authUrl,
+            codeVerifier,
+            state,
+            nonce,
+            xFapiInteractionId,
+        };
+    }
+    /**
+     * Retrieves tokens using an authorisation code.
+     *
+     * @param authorisationServerId - Authorisation server ID
+     * @param requestParams - OAuth callback parameters
+     * @param codeVerifier - PKCE code verifier from PAR
+     * @param state - State parameter from PAR
+     * @param nonce - Nonce parameter from PAR
+     * @returns Consolidated token set with validated claims
+     */
+    async retrieveTokens(authorisationServerId, requestParams, codeVerifier, state, nonce) {
+        return this.retrieveTokenEndpoint.retrieveTokens(authorisationServerId, requestParams, codeVerifier, state, nonce);
+    }
+    /**
+     * Retrieves user information from the UserInfo endpoint.
+     *
+     * @param authorisationServerId - Authorization server ID
+     * @param accessToken - Access token
+     * @returns UserInfo claims
+     */
+    async getUserInfo(authorisationServerId, accessToken) {
+        return this.userInfoEndpoint.getUserInfo(authorisationServerId, accessToken);
+    }
+    /**
+     * Gets the current date (for testing purposes).
+     *
+     * @returns Current date
+     */
+    getCurrentDate() {
+        return new Date();
+    }
+}