igcv3 - v1.1.0
    Preparing search index...

    Interface ConfigPreset

    Preset configuration for quick CSR generation. Presets bundle common settings for specific use cases (web, vpn, mTLS, etc.).

    interface ConfigPreset {
        description: string;
        organizationalUnitName?: string | string[];
        validityDays?: number;
        extensions?: { serverAuth?: boolean; clientAuth?: boolean };
        variables?: Record<
            string,
            {
                type: "input"
                | "list";
                message: string;
                validate?: string;
                choices?: string[];
                default?: string;
            },
        >;
        subjectAltName?: { templates: string[] };
        countryName?: string;
        organizationName?: string;
        sanitizeName?: boolean;
        keys?: {
            algo: "rsa" | "ecdsa" | "ed25519";
            size?: 2048 | 4096;
            curve?: "P-256" | "P-384" | "P-521";
        };
    }
    Index

    Properties

    description: string

    Human-readable description of the preset

    organizationalUnitName?: string | string[]

    Organizational unit(s) to include in subject

    validityDays?: number

    Certificate validity period override

    extensions?: { serverAuth?: boolean; clientAuth?: boolean }

    X.509 extension flags

    Type Declaration

    • OptionalserverAuth?: boolean

      Include TLS Web Server Authentication EKU

    • OptionalclientAuth?: boolean

      Include TLS Web Client Authentication EKU

    variables?: Record<
        string,
        {
            type: "input"
            | "list";
            message: string;
            validate?: string;
            choices?: string[];
            default?: string;
        },
    >

    Interactive variables for dynamic presets

    subjectAltName?: { templates: string[] }

    Subject Alternative Name templates

    Type Declaration

    • templates: string[]

      SAN templates with variable placeholders

    countryName?: string

    Override default country code

    organizationName?: string

    Override default organization name

    sanitizeName?: boolean

    Override filename sanitization behavior

    keys?: {
        algo: "rsa" | "ecdsa" | "ed25519";
        size?: 2048 | 4096;
        curve?: "P-256" | "P-384" | "P-521";
    }

    Key algorithm override for this preset

    Type Declaration

    • algo: "rsa" | "ecdsa" | "ed25519"

      Algorithm type

    • Optionalsize?: 2048 | 4096

      RSA key size (only for rsa)

    • Optionalcurve?: "P-256" | "P-384" | "P-521"

      ECDSA curve (only for ecdsa)