Index

accessCertificateControllerAccessCertificates (src/.../sdk.gen.ts)
accessCertificateControllerDelete (src/.../sdk.gen.ts)
accessCertificateControllerFindOne (src/.../sdk.gen.ts)
accessCertificateControllerFindOneParsed (src/.../sdk.gen.ts)
accessCertificateControllerRegister (src/.../sdk.gen.ts)
AUTH_VALIDATION_SCHEMA (src/.../auth.module.ts)
client (src/.../client.gen.ts)
CRYPTO_VALIDATION_SCHEMA (src/.../crypto.module.ts)
cryptoControllerOwnCert (src/.../sdk.gen.ts)
cryptoControllerOwnCertParsed (src/.../sdk.gen.ts)
DB_VALIDATION_SCHEMA (src/.../database.module.ts)
ED25519 (src/.../ed25519.ts)
healthControllerCheck (src/.../sdk.gen.ts)
ISSUER_VALIDATION_SCHEMA (src/.../issuer.module.ts)
KEY_VALIDATION_SCHEMA (src/.../key.module.ts)
oid4VpControllerGetValidPid (src/.../sdk.gen.ts)
oid4VpControllerGetValidRequest (src/.../sdk.gen.ts)
oid4VpControllerGetValidRequestWithQuery (src/.../sdk.gen.ts)
oid4VpControllerResponse (src/.../sdk.gen.ts)
oid4VpControllerSuccess (src/.../sdk.gen.ts)
REGISTRAR_VALIDATION_SCHEMA (src/.../registrar.module.ts)
registrationCertificateControllerAll (src/.../sdk.gen.ts)
registrationCertificateControllerDelete (src/.../sdk.gen.ts)
registrationCertificateControllerFindOne (src/.../sdk.gen.ts)
registrationCertificateControllerFindOneDecoded (src/.../sdk.gen.ts)
registrationCertificateControllerRegister (src/.../sdk.gen.ts)
relyingPartyControllerFindAll (src/.../sdk.gen.ts)
relyingPartyControllerRegister (src/.../sdk.gen.ts)
relyingPartyControllerRemove (src/.../sdk.gen.ts)
SESSION_VALIDATION_SCHEMA (src/.../session.module.ts)
statusListControllerCrlFile (src/.../sdk.gen.ts)
statusListControllerGetList (src/.../sdk.gen.ts)
token (vaul-client.ts)
url (vaul-client.ts)

src/registrar/generated/sdk.gen.ts

accessCertificateControllerAccessCertificates

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<
        AccessCertificateControllerAccessCertificatesData,
        ThrowOnError
    >,
) => {
    return (options.client ?? _heyApiClient).get<
        AccessCertificateControllerAccessCertificatesResponse,
        unknown,
        ThrowOnError
    >({
        url: '/relying-parties/{rp}/access-certificates',
        ...options,
    });
}

Get all access certificates by a relying party

accessCertificateControllerDelete

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<AccessCertificateControllerDeleteData, ThrowOnError>,
) => {
    return (options.client ?? _heyApiClient).delete<
        unknown,
        unknown,
        ThrowOnError
    >({
        security: [
            {
                scheme: 'bearer',
                type: 'http',
            },
        ],
        url: '/relying-parties/{rp}/access-certificates/{id}',
        ...options,
    });
}

Delete a certificate by id

accessCertificateControllerFindOne

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<AccessCertificateControllerFindOneData, ThrowOnError>,
) => {
    return (options.client ?? _heyApiClient).get<
        unknown,
        unknown,
        ThrowOnError
    >({
        url: '/relying-parties/{rp}/access-certificates/{id}',
        ...options,
    });
}

Get a certificate by id

accessCertificateControllerFindOneParsed

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<
        AccessCertificateControllerFindOneParsedData,
        ThrowOnError
    >,
) => {
    return (options.client ?? _heyApiClient).get<
        AccessCertificateControllerFindOneParsedResponse,
        unknown,
        ThrowOnError
    >({
        url: '/relying-parties/{rp}/access-certificates/{id}/parsed',
        ...options,
    });
}

Get a certificate by id and parse it via openssl Subject is not RFC 4514 conform

accessCertificateControllerRegister

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<AccessCertificateControllerRegisterData, ThrowOnError>,
) => {
    return (options.client ?? _heyApiClient).post<
        AccessCertificateControllerRegisterResponse,
        unknown,
        ThrowOnError
    >({
        security: [
            {
                scheme: 'bearer',
                type: 'http',
            },
        ],
        url: '/relying-parties/{rp}/access-certificates',
        ...options,
        headers: {
            'Content-Type': 'application/json',
            ...options?.headers,
        },
    });
}

Add a new access certificate

cryptoControllerOwnCert

Default value :

<ThrowOnError extends boolean = false>(
    options?: Options<CryptoControllerOwnCertData, ThrowOnError>,
) => {
    return (options?.client ?? _heyApiClient).get<
        CryptoControllerOwnCertResponse,
        unknown,
        ThrowOnError
    >({
        url: '/ca',
        ...options,
    });
}

Returns the certificate of the RP registrar.

cryptoControllerOwnCertParsed

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options?: Options<CryptoControllerOwnCertParsedData, ThrowOnError>,
) => {
    return (options?.client ?? _heyApiClient).get<
        CryptoControllerOwnCertParsedResponse,
        unknown,
        ThrowOnError
    >({
        url: '/ca/parsed',
        ...options,
    });
}

Returns the certificate of the RP registrar.

healthControllerCheck

Default value :

<ThrowOnError extends boolean = false>(
    options?: Options<HealthControllerCheckData, ThrowOnError>,
) => {
    return (options?.client ?? _heyApiClient).get<
        HealthControllerCheckResponse,
        HealthControllerCheckError,
        ThrowOnError
    >({
        url: '/health',
        ...options,
    });
}

oid4VpControllerGetValidPid

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<Oid4VpControllerGetValidPidData, ThrowOnError>,
) => {
    return (options.client ?? _heyApiClient).get<
        unknown,
        unknown,
        ThrowOnError
    >({
        url: '/oid4vp',
        ...options,
    });
}

Get a valid openid4vp request uri

oid4VpControllerGetValidRequest

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<Oid4VpControllerGetValidRequestData, ThrowOnError>,
) => {
    return (options.client ?? _heyApiClient).get<
        Oid4VpControllerGetValidRequestResponse,
        unknown,
        ThrowOnError
    >({
        url: '/oid4vp/{version}/{request}/{querylanguage}',
        ...options,
    });
}

Get an oid4vp authorization request as signed JWT

oid4VpControllerGetValidRequestWithQuery

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<
        Oid4VpControllerGetValidRequestWithQueryData,
        ThrowOnError
    >,
) => {
    return (options.client ?? _heyApiClient).get<
        Oid4VpControllerGetValidRequestWithQueryResponse,
        unknown,
        ThrowOnError
    >({
        url: '/oid4vp/{version}/{request}',
        ...options,
    });
}

deprecated

oid4VpControllerResponse

Default value :

<ThrowOnError extends boolean = false>(
    options?: Options<Oid4VpControllerResponseData, ThrowOnError>,
) => {
    return (options?.client ?? _heyApiClient).post<
        unknown,
        unknown,
        ThrowOnError
    >({
        url: '/oid4vp/response',
        ...options,
    });
}

Response endpoint

oid4VpControllerSuccess

Default value :

<ThrowOnError extends boolean = false>(
    options?: Options<Oid4VpControllerSuccessData, ThrowOnError>,
) => {
    return (options?.client ?? _heyApiClient).get<
        Oid4VpControllerSuccessResponse,
        unknown,
        ThrowOnError
    >({
        url: '/oid4vp/success',
        ...options,
    });
}

Dummy success endpoint

registrationCertificateControllerAll

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<RegistrationCertificateControllerAllData, ThrowOnError>,
) => {
    return (options.client ?? _heyApiClient).get<
        RegistrationCertificateControllerAllResponse,
        unknown,
        ThrowOnError
    >({
        url: '/relying-parties/{rp}/registration-certificates',
        ...options,
    });
}

Get all registration certificates by a relying party

registrationCertificateControllerDelete

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<RegistrationCertificateControllerDeleteData, ThrowOnError>,
) => {
    return (options.client ?? _heyApiClient).delete<
        unknown,
        unknown,
        ThrowOnError
    >({
        security: [
            {
                scheme: 'bearer',
                type: 'http',
            },
        ],
        url: '/relying-parties/{rp}/registration-certificates/{id}',
        ...options,
    });
}

Delete a certificate by id

registrationCertificateControllerFindOne

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<
        RegistrationCertificateControllerFindOneData,
        ThrowOnError
    >,
) => {
    return (options.client ?? _heyApiClient).get<
        RegistrationCertificateControllerFindOneResponse,
        RegistrationCertificateControllerFindOneError,
        ThrowOnError
    >({
        url: '/relying-parties/{rp}/registration-certificates/{id}',
        ...options,
    });
}

Get a certificate by id

registrationCertificateControllerFindOneDecoded

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<
        RegistrationCertificateControllerFindOneDecodedData,
        ThrowOnError
    >,
) => {
    return (options.client ?? _heyApiClient).get<
        RegistrationCertificateControllerFindOneDecodedResponse,
        unknown,
        ThrowOnError
    >({
        url: '/relying-parties/{rp}/registration-certificates/{id}/jws-decoded',
        ...options,
    });
}

Get a certificate by id decoded as jws

registrationCertificateControllerRegister

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<
        RegistrationCertificateControllerRegisterData,
        ThrowOnError
    >,
) => {
    return (options.client ?? _heyApiClient).post<
        RegistrationCertificateControllerRegisterResponse,
        unknown,
        ThrowOnError
    >({
        security: [
            {
                scheme: 'bearer',
                type: 'http',
            },
        ],
        url: '/relying-parties/{rp}/registration-certificates',
        ...options,
        headers: {
            'Content-Type': 'application/json',
            ...options?.headers,
        },
    });
}

Add a new registration certificate

relyingPartyControllerFindAll

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options?: Options<RelyingPartyControllerFindAllData, ThrowOnError>,
) => {
    return (options?.client ?? _heyApiClient).get<
        RelyingPartyControllerFindAllResponse,
        unknown,
        ThrowOnError
    >({
        url: '/relying-parties',
        ...options,
    });
}

Get all relying parties

relyingPartyControllerRegister

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<RelyingPartyControllerRegisterData, ThrowOnError>,
) => {
    return (options.client ?? _heyApiClient).post<
        RelyingPartyControllerRegisterResponse,
        unknown,
        ThrowOnError
    >({
        security: [
            {
                scheme: 'bearer',
                type: 'http',
            },
        ],
        url: '/relying-parties',
        ...options,
        headers: {
            'Content-Type': 'application/json',
            ...options?.headers,
        },
    });
}

relyingPartyControllerRemove

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options: Options<RelyingPartyControllerRemoveData, ThrowOnError>,
) => {
    return (options.client ?? _heyApiClient).delete<
        unknown,
        unknown,
        ThrowOnError
    >({
        security: [
            {
                scheme: 'bearer',
                type: 'http',
            },
        ],
        url: '/relying-parties/{id}',
        ...options,
    });
}

Removes a relying party and it's associated certificates. Only used to tidy up.

statusListControllerCrlFile

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options?: Options<StatusListControllerCrlFileData, ThrowOnError>,
) => {
    return (options?.client ?? _heyApiClient).get<
        StatusListControllerCrlFileResponse,
        unknown,
        ThrowOnError
    >({
        url: '/status-management/crl',
        ...options,
    });
}

Returns the crl.der file

statusListControllerGetList

Default value :

<
    ThrowOnError extends boolean = false,
>(
    options?: Options<StatusListControllerGetListData, ThrowOnError>,
) => {
    return (options?.client ?? _heyApiClient).get<
        StatusListControllerGetListResponse,
        unknown,
        ThrowOnError
    >({
        url: '/status-management/status-list',
        ...options,
    });
}

Get the status list

src/auth/auth.module.ts

AUTH_VALIDATION_SCHEMA

Type : object

Default value :

{
    AUTH_API_KEY: Joi.string().required(),
}

src/registrar/generated/client.gen.ts

client

Default value : createClient(createConfig<ClientOptions>())

src/crypto/key/crypto/crypto.module.ts

CRYPTO_VALIDATION_SCHEMA

Type : object

Default value :

{
    CRYPTO_ALG: Joi.string().valid('ES256', 'Ed25519').default('ES256'),
}

src/database/database.module.ts

DB_VALIDATION_SCHEMA

Type : object

Default value :

{
    DB_TYPE: Joi.string().valid('sqlite', 'postgres').default('sqlite'),
    DB_HOST: Joi.string().when('DB_TYPE', {
        is: 'sqlite',
        then: Joi.optional(),
        otherwise: Joi.required(),
    }),
    DB_PORT: Joi.number().when('DB_TYPE', {
        is: 'sqlite',
        then: Joi.optional(),
        otherwise: Joi.required(),
    }),
    DB_USERNAME: Joi.string().when('DB_TYPE', {
        is: 'sqlite',
        then: Joi.optional(),
        otherwise: Joi.required(),
    }),
    DB_PASSWORD: Joi.string().when('DB_TYPE', {
        is: 'sqlite',
        then: Joi.optional(),
        otherwise: Joi.required(),
    }),
    DB_DATABASE: Joi.string().when('DB_TYPE', {
        is: 'sqlite',
        then: Joi.optional(),
        otherwise: Joi.required(),
    }),
}

src/crypto/key/crypto/ed25519.ts

ED25519

Type : CryptoImplementation

Default value :

{
    alg: 'EdDSA',
    async generateKeyPair() {
        const keyPair = await crypto.webcrypto.subtle.generateKey(
            {
                name: 'EdDSA',
                namedCurve: 'Ed25519',
            },
            true,
            ['sign', 'verify'],
        );

        const publicKey = await crypto.webcrypto.subtle.exportKey(
            'jwk',
            keyPair.publicKey,
        );
        const privateKey = await crypto.webcrypto.subtle.exportKey(
            'jwk',
            keyPair.privateKey,
        );

        return { publicKey, privateKey };
    },
    async getSigner(privateKeyJWK: object) {
        const privateKey = await crypto.webcrypto.subtle.importKey(
            'jwk',
            privateKeyJWK,
            {
                name: 'EdDSA',
                namedCurve: 'Ed25519',
            },
            false,
            ['sign'],
        );

        return async (data: string) => {
            const signature = await crypto.webcrypto.subtle.sign(
                'EdDSA',
                privateKey,
                new TextEncoder().encode(data),
            );

            return Buffer.from(signature).toString('base64url');
        };
    },
    async getVerifier(publicKeyJWK: object) {
        const publicKey = await crypto.webcrypto.subtle.importKey(
            'jwk',
            publicKeyJWK,
            {
                name: 'EdDSA',
                namedCurve: 'Ed25519',
            },
            false,
            ['verify'],
        );

        return async (data: string, signatureBase64url: string) => {
            const signature = Buffer.from(signatureBase64url, 'base64url');
            const isVerified = await crypto.webcrypto.subtle.verify(
                'EdDSA',
                publicKey,
                signature,
                new TextEncoder().encode(data),
            );

            return isVerified;
        };
    },
}

src/issuer/issuer.module.ts

ISSUER_VALIDATION_SCHEMA

Type : object

Default value :

{
    PUBLIC_URL: Joi.string(),
}

src/crypto/key/key.module.ts

KEY_VALIDATION_SCHEMA

Type : object

Default value :

{
    KM_TYPE: Joi.string().valid('file', 'vault').default('file'),

    // Vault-related config
    VAULT_URL: Joi.string().uri().when('KM_TYPE', {
        is: 'vault',
        then: Joi.required(),
        otherwise: Joi.optional(),
    }),
    VAULT_TOKEN: Joi.string().when('KM_TYPE', {
        is: 'vault',
        then: Joi.required(),
        otherwise: Joi.optional(),
    }),
    VAULT_KEY_ID: Joi.string().when('KM_TYPE', {
        is: 'vault',
        then: Joi.string().default('key-id'),
        otherwise: Joi.optional(),
    }),
}

src/registrar/registrar.module.ts

REGISTRAR_VALIDATION_SCHEMA

Type : object

Default value :

{
    REGISTRAR_URL: Joi.string(),
    REGISTRAR_RP_NAME: Joi.string().when('REGISTRAR_URL', {
        is: Joi.exist(),
        then: Joi.required(),
    }),
    KEYCLOAK_REALM: Joi.string().when('REGISTRAR_URL', {
        is: Joi.exist(),
        then: Joi.required(),
    }),
    KEYCLOAK_AUTH_SERVER_URL: Joi.string().when('REGISTRAR_URL', {
        is: Joi.exist(),
        then: Joi.required(),
    }),
    KEYCLOAK_RESOURCE: Joi.string().when('REGISTRAR_URL', {
        is: Joi.exist(),
        then: Joi.required(),
    }),
    KEYCLOAK_CREDENTIALS_SECRET: Joi.string().when('REGISTRAR_URL', {
        is: Joi.exist(),
        then: Joi.required(),
    }),
}

src/session/session.module.ts

SESSION_VALIDATION_SCHEMA

Type : object

Default value :

{
    SESSION_TIDY_UP_INTERVAL: Joi.number().default(60 * 60), // default to every hour
    SESSION_TTL: Joi.number().default(24 * 60 * 60), // default to 24 hours
}

vaul-client.ts

token

Default value : process.env.VAULT_TOKEN || 'myroot'

url

Default value : process.env.VAULT_URL || 'http://localhost:8200'

Index

src/registrar/generated/sdk.gen.ts

src/auth/auth.module.ts

src/registrar/generated/client.gen.ts

src/crypto/key/crypto/crypto.module.ts

src/database/database.module.ts

src/crypto/key/crypto/ed25519.ts

src/issuer/issuer.module.ts

src/crypto/key/key.module.ts

src/registrar/registrar.module.ts

src/session/session.module.ts

vaul-client.ts

results matching ""

No results matching ""