API JavaScript HSM Dinamo
    Preparing search index...

    Interface Pix

    interface Pix {
        PIXSign(
            flags: PIX_SIGN_RNS,
            keyId: string,
            certId: string,
            unsignedPixEnvelope: Buffer,
        ): Promise<Buffer<ArrayBufferLike>>;
        PIXVerify(
            chainId: string,
            crlId: string | null,
            flags: number,
            signedPixEnvelope: Buffer,
        ): Promise<void>;
        PIXDictSign(
            keyId: string,
            certId: string,
            unsignedDictEnvelope: Buffer,
        ): Promise<Buffer<ArrayBufferLike>>;
        PIXDictVerify(
            chainId: string,
            crlId: string | null,
            flags: number,
            signedDictEnvelope: Buffer,
        ): Promise<void>;
        PIXJWSSign(
            keyId: string,
            flags: number,
            header: Buffer,
            payload: Buffer,
        ): Promise<Buffer<ArrayBufferLike>>;
        PIXJWSCheck(
            chainId: string,
            crlId: string | null,
            jws: Buffer,
            flags: number,
        ): Promise<{ header: Buffer; payload: Buffer }>;
        PIXPost(
            url: string,
            headers: Record<string, string>,
            body: string | Buffer<ArrayBufferLike>,
            hsmOptions?: PixHsmHttpOptions,
            flags?: number,
        ): Promise<PixHttpResponse>;
        PIXPut(
            url: string,
            headers: Record<string, string>,
            body: string | Buffer<ArrayBufferLike>,
            hsmOptions?: PixHsmHttpOptions,
            flags?: number,
        ): Promise<PixHttpResponse>;
        PIXGet(
            url: string,
            headers: Record<string, string>,
            hsmOptions?: PixHsmHttpOptions,
            flags?: number,
        ): Promise<PixHttpResponse>;
        PIXDelete(
            url: string,
            headers: Record<string, string>,
            hsmOptions?: PixHsmHttpOptions,
            flags?: number,
        ): Promise<PixHttpResponse>;
    }
    Index
    PIXSign PIXVerify PIXDictSign PIXDictVerify PIXJWSSign PIXJWSCheck PIXPost PIXPut PIXGet PIXDelete

    • Assina um envelope PIX.

      Parameters

      • flags: PIX_SIGN_RNS

        Sinalizadores de controle para a operação de assinatura.

      • keyId: string

        O identificador da chave a ser usada para a assinatura.

      • certId: string

        O identificador do certificado a ser usado.

      • unsignedPixEnvelope: Buffer

        O envelope PIX não assinado.

      Returns Promise<Buffer<ArrayBufferLike>>

      Uma promessa que resolve com o envelope PIX assinado.

    • Verifica um envelope PIX assinado.

      Parameters

      • chainId: string

        O identificador da cadeia de certificados.

      • crlId: string | null

        O identificador da Lista de Certificados Revogados (opcional).

      • flags: number

        Sinalizadores de controle para a operação de verificação.

      • signedPixEnvelope: Buffer

        O envelope PIX assinado a ser verificado.

      Returns Promise<void>

      Uma promessa que resolve se a verificação for bem-sucedida.

    • Assina uma entrada de dicionário PIX.

      Parameters

      • keyId: string

        O identificador da chave a ser usada para a assinatura.

      • certId: string

        O identificador do certificado a ser usado.

      • unsignedDictEnvelope: Buffer

        O envelope de dicionário não assinado.

      Returns Promise<Buffer<ArrayBufferLike>>

      Uma promessa que resolve com o envelope de dicionário assinado.

    • Verifica uma entrada de dicionário PIX assinada.

      Parameters

      • chainId: string

        O identificador da cadeia de certificados.

      • crlId: string | null

        O identificador da Lista de Certificados Revogados (opcional).

      • flags: number

        Sinalizadores de controle para a operação de verificação.

      • signedDictEnvelope: Buffer

        O envelope de dicionário assinado a ser verificado.

      Returns Promise<void>

      Uma promessa que resolve se a verificação for bem-sucedida.

    • Gera uma assinatura JWS.

      Parameters

      • keyId: string

        O identificador da chave a ser usada para a assinatura.

      • flags: number

        Sinalizadores de controle para a geração do JWS.

      • header: Buffer

        O cabeçalho JWS.

      • payload: Buffer

        O payload JWS.

      Returns Promise<Buffer<ArrayBufferLike>>

      Uma promessa que resolve com o JWS gerado.

    • Verifica uma assinatura JWS.

      Parameters

      • chainId: string

        O identificador da cadeia de certificados.

      • crlId: string | null

        O identificador da Lista de Certificados Revogados (opcional).

      • jws: Buffer

        O JWS a ser verificado.

      • flags: number

        Sinalizadores de controle para a verificação.

      Returns Promise<{ header: Buffer; payload: Buffer }>

      Uma promessa que resolve com o cabeçalho e o payload do JWS se a verificação for bem-sucedida.

    • Operação de Rede mTLS - POST. Delega a requisição HTTP POST ao native_host (dinamonh), que executa o handshake mTLS e a operação de rede inteiramente fora do processo Node, usando a chave privada do HSM referenciada por hsmOptions.

      Parameters

      • url: string

        A URL de destino da requisição.

      • headers: Record<string, string>

        Os cabeçalhos HTTP da requisição.

      • body: string | Buffer<ArrayBufferLike>

        O corpo da requisição.

      • OptionalhsmOptions: PixHsmHttpOptions

        FQNs de chave/certificado/cadeia do HSM e demais parâmetros de sessão usados pelo native_host para o handshake mTLS.

      • Optionalflags: number

        Sinalizadores de controle da requisição (veja enums.PIX_HTTP_FLAGS).

      Returns Promise<PixHttpResponse>

      Uma promessa que resolve com o envelope completo retornado pela operação do native_host - { status, rcode, http_status, response_headers, response_body } - e não apenas com o corpo da resposta HTTP (veja PixHttpResponse).

    • Operação de Rede mTLS - PUT. Delega a requisição HTTP PUT ao native_host (dinamonh), que executa o handshake mTLS e a operação de rede inteiramente fora do processo Node, usando a chave privada do HSM referenciada por hsmOptions.

      Parameters

      • url: string

        A URL de destino da requisição.

      • headers: Record<string, string>

        Os cabeçalhos HTTP da requisição.

      • body: string | Buffer<ArrayBufferLike>

        O corpo da requisição.

      • OptionalhsmOptions: PixHsmHttpOptions

        FQNs de chave/certificado/cadeia do HSM e demais parâmetros de sessão usados pelo native_host para o handshake mTLS.

      • Optionalflags: number

        Sinalizadores de controle da requisição (veja enums.PIX_HTTP_FLAGS).

      Returns Promise<PixHttpResponse>

      Uma promessa que resolve com o envelope completo retornado pela operação do native_host - { status, rcode, http_status, response_headers, response_body } - e não apenas com o corpo da resposta HTTP (veja PixHttpResponse).

    • Operação de Rede mTLS - GET. Delega a requisição HTTP GET ao native_host (dinamonh), que executa o handshake mTLS e a operação de rede inteiramente fora do processo Node, usando a chave privada do HSM referenciada por hsmOptions.

      Parameters

      • url: string

        A URL de destino da requisição.

      • headers: Record<string, string>

        Os cabeçalhos HTTP da requisição.

      • OptionalhsmOptions: PixHsmHttpOptions

        FQNs de chave/certificado/cadeia do HSM e demais parâmetros de sessão usados pelo native_host para o handshake mTLS.

      • Optionalflags: number

        Sinalizadores de controle da requisição (veja enums.PIX_HTTP_FLAGS).

      Returns Promise<PixHttpResponse>

      Uma promessa que resolve com o envelope completo retornado pela operação do native_host - { status, rcode, http_status, response_headers, response_body } - e não apenas com o corpo da resposta HTTP (veja PixHttpResponse).

    • Operação de Rede mTLS - DELETE. Delega a requisição HTTP DELETE ao native_host (dinamonh), que executa o handshake mTLS e a operação de rede inteiramente fora do processo Node, usando a chave privada do HSM referenciada por hsmOptions.

      Parameters

      • url: string

        A URL de destino da requisição.

      • headers: Record<string, string>

        Os cabeçalhos HTTP da requisição.

      • OptionalhsmOptions: PixHsmHttpOptions

        FQNs de chave/certificado/cadeia do HSM e demais parâmetros de sessão usados pelo native_host para o handshake mTLS.

      • Optionalflags: number

        Sinalizadores de controle da requisição (veja enums.PIX_HTTP_FLAGS).

      Returns Promise<PixHttpResponse>

      Uma promessa que resolve com o envelope completo retornado pela operação do native_host - { status, rcode, http_status, response_headers, response_body } - e não apenas com o corpo da resposta HTTP (veja PixHttpResponse).

    Settings

    On This Page
    Methods