/// <reference types="node" />
import { IncomingMessage } from 'http';
import { AuthorizationParameters as OidcAuthorizationParameters } from 'openid-client';
/**
 * Configuration properties.
 */
export interface Config {
    /**
     * The secret(s) used to derive an encryption key for the user identity in a session cookie and
     * to sign the transient cookies used by the login callback.
     * Use a single string key or array of keys for an encrypted session cookie.
     */
    secret: string | Array<string>;
    /**
     * Object defining application session cookie attributes.
     */
    session: SessionConfig;
    /**
     * Boolean value to enable ZeusAuth's logout feature.
     */
    zIdentityLogout: boolean;
    /**
     *  URL parameters used when redirecting users to the authorization server to log in.
     *
     *  If this property is not provided by your application, its default values will be:
     *
     * ```js
     * {
     *   response_type: 'id_token',
     *   response_mode: 'form_post,
     *   scope: openid profile email'
     * }
     * ```
     *
     * New values can be passed in to change what is returned from the authorization server
     * depending on your specific scenario.
     *
     * For example, to receive an access token for an API, you could initialize like the sample below.
     * Note that `response_mode` can be omitted because the OAuth2 default mode of `query` is fine:
     *
     * ```js
     * app.use(auth({
     *   authorizationParams: {
     *     response_type: 'code',
     *     scope: 'openid profile email read:reports',
     *     audience: 'https://your-api-identifier'
     *   }
     * }));
     * ```
     *
     * Additional custom parameters can be added as well:
     *
     * ```js
     * app.use(auth({
     *   authorizationParams: {
     *     // Note: you need to provide required parameters if this object is set.
     *     response_type: "id_token",
     *     response_mode: "form_post",
     *     scope: "openid profile email",
     *     // Additional parameters
     *     acr_value: "tenant:test-tenant",
     *     custom_param: "custom-value"
     *   }
     * }));
     * ```
     */
    authorizationParams: AuthorizationParameters;
    /**
     * The root URL for the application router, eg https://localhost
     */
    baseURL: string;
    /**
     * The Client ID for your application.
     */
    clientID: string;
    /**
     * The Client Secret for your application.
     * Required when requesting access tokens.
     */
    clientSecret?: string;
    /**
     * Integer value for the system clock's tolerance (leeway) in seconds for ID token verification.`
     * Default is 60
     */
    clockTolerance: number;
    /**
     * Integer value for the http timeout in ms for authentication requests.
     * Default is 5000
     */
    httpTimeout: number;
    /**
     * To opt-out of sending the library and node version to your authorization server
     * via the `ZIdentity-Client` header. Default is `true
     */
    enableTelemetry: boolean;
    /**
     * Function that returns an object with URL-safe state values for login.
     * Used for passing custom state parameters to your authorization server.
     *
     * ```js
     * app.use(auth({
     *   ...
     *   getLoginState(req, options) {
     *     return {
     *       returnTo: options.returnTo || req.originalUrl,
     *       customState: 'foo'
     *     };
     *   }
     * }));
     * ``
     */
    getLoginState: (req: IncomingMessage, options: LoginOptions) => Record<string, any>;
    /**
     * Array value of claims to remove from the ID token before storing the cookie session.
     * Default is `['aud', 'iss', 'iat', 'exp', 'nbf', 'nonce', 'azp', 'auth_time', 's_hash', 'at_hash', 'c_hash' ]`
     */
    identityClaimFilter: string[];
    /**
     * Boolean value to log the user out from the identity provider on application logout. Default is `false`
     */
    idpLogout: boolean;
    /**
     * String value for the expected ID token algorithm. Default is 'RS256'
     */
    idTokenSigningAlg: string;
    /**
     * REQUIRED. The root URL for the token issuer with no trailing slash.
     */
    issuerBaseURL: string;
    /**
     * Set a fallback cookie with no SameSite attribute when response_mode is form_post.
     * Default is true
     */
    legacySameSiteCookie: boolean;
    routes: {
        /**
         * Either a relative path to the application or a valid URI to an external domain.
         * This value must be registered on the authorization server.
         * The user will be redirected to this after a logout has been performed.
         */
        postLogoutRedirect: string;
        /**
         * Relative path to the application callback to process the response from the authorization server.
         */
        callback: string;
    };
}
/**
 * Configuration parameters used for the application session.
 */
export interface SessionConfig {
    /**
     * String value for the cookie name used for the internal session.
     * This value must only include letters, numbers, and underscores.
     * Default is `appSession`.
     */
    name: string;
    /**
     * If you want your session duration to be rolling, eg reset everytime the
     * user is active on your site, set this to a `true`. If you want the session
     * duration to be absolute, where the user is logged out a fixed time after login,
     * regardless of activity, set this to `false`
     * Default is `true`.
     */
    rolling: boolean;
    /**
     * Integer value, in seconds, for application session rolling duration.
     * The amount of time for which the user must be idle for then to be logged out.
     * Default is 86400 seconds (1 day).
     */
    rollingDuration: number;
    /**
     * Integer value, in seconds, for application absolute rolling duration.
     * The amount of time after the user has logged in that they will be logged out.
     * Set this to `false` if you don't want an absolute duration on your session.
     * Default is 604800 seconds (7 days).
     */
    absoluteDuration: boolean | number;
    cookie: CookieConfig;
}
export interface CookieConfig {
    /**
     * Domain name for the cookie.
     * Passed to the [Response cookie](https://expressjs.com/en/api.html#res.cookie) as `domain`
     */
    domain?: string;
    /**
     * Path for the cookie.
     * Passed to the [Response cookie](https://expressjs.com/en/api.html#res.cookie) as `path`
     */
    path?: string;
    /**
     * Set to true to use a transient cookie (cookie without an explicit expiration).
     * Default is `false`
     */
    transient: boolean;
    /**
     * Flags the cookie to be accessible only by the web server.
     * Passed to the [Response cookie](https://expressjs.com/en/api.html#res.cookie) as `httponly`.
     * Defaults to `true`.
     */
    httpOnly: boolean;
    /**
     * Marks the cookie to be used over secure channels only.
     * Passed to the [Response cookie](https://expressjs.com/en/api.html#res.cookie) as `secure`.
     * Defaults to the protocol of {@link Config.baseURL}.
     */
    secure?: boolean;
    /**
     * Value of the SameSite Set-Cookie attribute.
     * Passed to the [Response cookie](https://expressjs.com/en/api.html#res.cookie) as `samesite`.
     * Defaults to "Lax" but will be adjusted based on {@link AuthorizationParameters.response_type}.
     */
    sameSite: 'lax' | 'strict' | 'none';
}
export interface AuthorizationParameters extends OidcAuthorizationParameters {
    scope: string;
    response_mode: 'query' | 'form_post';
    response_type: 'id_token' | 'code id_token' | 'code';
    signup?: boolean;
}
export declare type GetLoginState = (req: any, options: LoginOptions) => {
    [key: string]: any;
};
/**
 * Custom options to pass to login.
 */
export interface LoginOptions {
    /**
     * Override the default {@link Config.authorizationParams authorizationParams}
     */
    authorizationParams?: Partial<AuthorizationParameters>;
    /**
     *  URL to return to after login, overrides the Default is {@link Config.baseURL}
     */
    returnTo?: string;
    /**
     *  Generate a unique state value for use during login transactions.
     */
    getLoginState?: GetLoginState;
}
/**
 * Custom options to pass to logout.
 */
export interface LogoutOptions {
    /**
     *  URL to returnTo after logout, overrides the
     *  Default in {@link Config.routes.postLogoutRedirect routes.postLogoutRedirect}
     */
    returnTo?: string;
}
//# sourceMappingURL=config.d.ts.map