vault/ui/api-client/dist/models/TransitVerifyRequest.d.ts

/**
 * HashiCorp Vault API
 * HTTP API that gives you full access to Vault. All API routes are prefixed with `/v1/`.
 *
 * The version of the OpenAPI document: 1.20.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
/**
 *
 * @export
 * @interface TransitVerifyRequest
 */
export interface TransitVerifyRequest {
    /**
     * Deprecated: use "hash_algorithm" instead.
     * @type {string}
     * @memberof TransitVerifyRequest
     */
    algorithm?: string;
    /**
     * Specifies a list of items for processing. When this parameter is set, any supplied 'input', 'hmac', 'cmac' or 'signature' parameters will be ignored. Responses are returned in the 'batch_results' array component of the 'data' element of the response. Any batch output will preserve the order of the batch input
     * @type {Array<object>}
     * @memberof TransitVerifyRequest
     */
    batchInput?: Array<object>;
    /**
     * The CMAC, including vault header/key version (Enterprise only)
     * @type {string}
     * @memberof TransitVerifyRequest
     */
    cmac?: string;
    /**
     * Base64 encoded context for key derivation. Required if key derivation is enabled; currently only available with ed25519 keys.
     * @type {string}
     * @memberof TransitVerifyRequest
     */
    context?: string;
    /**
     * Hash algorithm to use (POST body parameter). Valid values are: * sha1 * sha2-224 * sha2-256 * sha2-384 * sha2-512 * sha3-224 * sha3-256 * sha3-384 * sha3-512 * none Defaults to "sha2-256". Not valid for all key types. See note about none on signing path.
     * @type {string}
     * @memberof TransitVerifyRequest
     */
    hashAlgorithm?: string;
    /**
     * The HMAC, including vault header/key version
     * @type {string}
     * @memberof TransitVerifyRequest
     */
    hmac?: string;
    /**
     * The base64-encoded input data to verify
     * @type {string}
     * @memberof TransitVerifyRequest
     */
    input?: string;
    /**
     * MAC length to use (POST body parameter). Valid values are:
     * @type {number}
     * @memberof TransitVerifyRequest
     */
    macLength?: number;
    /**
     * The method by which to unmarshal the signature when verifying. The default is 'asn1' which is used by openssl and X.509; can also be set to 'jws' which is used for JWT signatures in which case the signature is also expected to be url-safe base64 encoding instead of standard base64 encoding. Currently only valid for ECDSA P-256 key types".
     * @type {string}
     * @memberof TransitVerifyRequest
     */
    marshalingAlgorithm?: string;
    /**
     * Set to 'true' when the input is already hashed. If the key type is 'rsa-2048', 'rsa-3072' or 'rsa-4096', then the algorithm used to hash the input should be indicated by the 'algorithm' parameter.
     * @type {boolean}
     * @memberof TransitVerifyRequest
     */
    prehashed?: boolean;
    /**
     * The salt length used to sign. Currently only applies to the RSA PSS signature scheme. Options are 'auto' (the default used by Golang, causing the salt to be as large as possible when signing), 'hash' (causes the salt length to equal the length of the hash used in the signature), or an integer between the minimum and the maximum permissible salt lengths for the given RSA key size. Defaults to 'auto'.
     * @type {string}
     * @memberof TransitVerifyRequest
     */
    saltLength?: string;
    /**
     * The signature, including vault header/key version
     * @type {string}
     * @memberof TransitVerifyRequest
     */
    signature?: string;
    /**
     * The signature algorithm to use for signature verification. Currently only applies to RSA key types. Options are 'pss' or 'pkcs1v15'. Defaults to 'pss'
     * @type {string}
     * @memberof TransitVerifyRequest
     */
    signatureAlgorithm?: string;
    /**
     * Base64 encoded context for Ed25519ph and Ed25519ctx signatures. Currently only available with Ed25519 keys. (Enterprise Only)
     * @type {string}
     * @memberof TransitVerifyRequest
     */
    signatureContext?: string;
}
/**
 * Check if a given object implements the TransitVerifyRequest interface.
 */
export declare function instanceOfTransitVerifyRequest(value: object): value is TransitVerifyRequest;
export declare function TransitVerifyRequestFromJSON(json: any): TransitVerifyRequest;
export declare function TransitVerifyRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransitVerifyRequest;
export declare function TransitVerifyRequestToJSON(json: any): TransitVerifyRequest;
export declare function TransitVerifyRequestToJSONTyped(value?: TransitVerifyRequest | null, ignoreDiscriminator?: boolean): any;