lti-tool Documentation
    Preparing search index...

    Interface LTIConfig

    Configuration object for initializing an LTI Tool instance. Contains cryptographic keys, secrets, and storage adapter.

    interface LTIConfig {
        additionalPublicKeys?: AdditionalPublicKey[];
        dynamicRegistration?: DynamicRegistrationConfig;
        keyPair: CryptoKeyPair;
        logger?: Logger;
        security?: {
            keyId?: string;
            nonceExpirationSeconds?: number;
            stateExpirationSeconds?: number;
            trustedAudiences?: string[];
        };
        stateSecret: Uint8Array;
        storage: LTIStorage;
    }
    Index
    additionalPublicKeys? dynamicRegistration? keyPair logger? security? stateSecret storage
    additionalPublicKeys?: AdditionalPublicKey[]

    Additional public keys to publish in the JWKS alongside keyPair's public key.

    These are publish-only: keyPair remains the only signer. Use them to keep a previous key verifiable while tokens signed with it are still in flight during a rotation. Each kid must be unique across the active key and all additional keys, and each entry's alg defaults to 'RS256'.

    dynamicRegistration?: DynamicRegistrationConfig

    Dynamic registration configuration for LTI 1.3 tool registration

    keyPair: CryptoKeyPair

    RSA key pair for signing JWTs and providing JWKS endpoint

    logger?: Logger

    Optional pino logger

    security?: {
        keyId?: string;
        nonceExpirationSeconds?: number;
        stateExpirationSeconds?: number;
        trustedAudiences?: string[];
    }

    Security configuration options

    Type Declaration

    • OptionalkeyId?: string

      Key ID for JWKS and JWT signing (defaults to 'main')

    • OptionalnonceExpirationSeconds?: number

      Nonce expiration time in seconds (defaults to 600 = 10 minutes)

    • OptionalstateExpirationSeconds?: number

      State JWT expiration time in seconds (defaults to 600 = 10 minutes)

    • OptionaltrustedAudiences?: string[]

      Additional JWT audience values to trust when a launch ID Token includes audiences besides this tool's client ID. Most tools should leave this unset.

    stateSecret: Uint8Array

    Secret key used for signing state JWTs during OIDC flow (minimum 32 bytes recommended)

    storage: LTIStorage

    Storage adapter for persisting platforms, sessions, and nonces

    Settings
    Member Visibility

    On This Page
    Properties