FLAT
CouperSevenval TechnologiesDocker ImageGithub
master
master
  • Changelog
  • FLAT
  • Administration
    • Configuration
    • Docker
    • Logging
  • Cookbook
    • Using the Built-in Mocking
    • Performing Additional Checks on JWT Access Tokens
    • Logging Custom Fields
    • Using Environment Variables
    • Handling Errors with an Error Flow
    • File Serving
    • Forwarding a Request to an Upstream API
    • Extracting Common Initialization Flow Tasks
    • Encoding and Decoding JWT
    • Passing Header Fields to the Client
    • How can I pass an arbitrary header field to an upstream system?
    • Performing Additional Checks on JWT Access Tokens
    • Proxying requests to Upstream APIs
    • Increasing the Request Timeout
    • How can I see what the client requested?
    • Using Swagger UI for API Documentation
    • Testing API Requests
    • Testing with Backend Requests
    • Testing Templates
    • Sending POST Requests
    • Processing Upstream Responses
    • Protecting Access using JWT Tokens
  • Reference
    • Configuration
    • Debugging
    • flat CLI
    • Flow
    • Variables
    • OpenAPI / Swagger Integration
    • OpenAPI
      • CORS - Cross-Origin Resource Sharing
    • OpenAPI
      • Differences from Swagger
    • OpenAPI
      • Mocking
    • OpenAPI
      • Routing
    • OpenAPI
      • Security
    • OpenAPI
      • Upstream APIs
    • OpenAPI
      • Validation
    • Flow Actions
      • assert Action
      • auth Action
      • backend-flow Action
      • copy Action
      • debug Action
      • dump Action
      • echo Action
      • error Action
      • eval Action
      • log Action
      • nameshave Action
      • pass-body Action
      • proxy-request Action
      • regex Action
      • request Action
      • requests Action
      • serve Action
      • set-config Action
      • set-env Action
      • set-response-headers Action
      • set-status Action
      • sub-flow Action
      • template Action
      • test-request Action
      • xslt Action
    • Functions
      • apply-codecs()
      • array-reverse()
      • array()
      • base64-decode()
      • base64-encode()
      • body()
      • calc-signature()
      • capitalize-first()
      • content()
      • decrypt-xml()
      • decrypt()
      • encrypt()
      • ends-with()
      • file-exists()
      • fit-document()
      • fit-log()
      • fit-serialize()
      • get-log()
      • has-class()
      • html-parse()
      • join()
      • json-doc()
      • json-parse()
      • json-stringify()
      • json-to-csv()
      • json-to-xml()
      • jwt-decode()
      • jwt-encode()
      • ldap-lookup()
      • ldap-query()
      • lookup()
      • matches()
      • md5()
      • replace()
      • sort()
      • split()
      • tolower()
      • toupper()
      • trim()
      • unixtime()
      • urldecode(), url-decode()
      • urlencode(), url-encode()
      • uuid3() and uuid4()
      • verify-signature()
      • verify-xmldsig()
      • xml-parse()
      • xml-to-json()
    • Templating
      • {{,}}
      • Comment {{// …}}
      • Dot {{.}}
      • Conditional `{{if <condition>}} … {{elseif <condition> }} … {{else}} … {{end}}
      • loop
      • ?? Operator
      • Object XML Notation (OXN)
      • Pair Producer {{: …}}
      • Placeholder
      • Template Variables
      • with
    • Testing
  • Tutorial
Powered by GitBook
On this page
  • Supported Algorithms
  • Example
  • See also

Was this helpful?

  1. Reference
  2. Functions

calc-signature()

Previousbody()Nextcapitalize-first()

Last updated 5 years ago

Was this helpful?

string calc-signature(string data, string private_key [, string passphrase [, string algorithm]])

The calc-signature function calculates a signature from the given input using the given private_key (in PEM format, with or without boundaries). The optional parameter passphrase is the pass phrase for decrypting an encrypted private key (the default is the empty string). The optional parameter algorithm is the signing algorithm (the default is SHA256). The resulting signature is Base64-encoded.

See for the supported private key format.

Supported Algorithms

  • DSA

  • DSA-SHA

  • MD2

  • MD4

  • MD5

  • RIPEMD160

  • SHA

  • SHA1

  • SHA224

  • SHA256

  • SHA384

  • SHA512

  • dsaEncryption

  • dsaWithSHA

  • ecdsa-with-SHA1

  • md2

  • md4

  • md5

  • ripemd160

  • sha

  • sha1

  • sha224

  • sha256

  • sha384

  • sha512

Example

<flow>
  <template>
  {
    {{$data := 'my data' }}
    {{$private_key := 'MIIEvwIBADANBgkqhkiG9w0BA…WygYMAMY8YaiAGwLtBsjrh7S12agaEQg=='}}
    {{$signature := calc-signature($data, $env/MY_PRIVATE_KEY) }}
    {{$signature := calc-signature($data, $private_key, "", "SHA384") }}
    {{$signature := calc-signature($data, $env/MY_ENCRYPTED_PRIVATE_KEY, $env/MY_PASSPHRASE) }}
    {{$signature := calc-signature($data, $env/MY_ENCRYPTED_KEY, $env/MY_PASSPHRASE, 'SHA512') }}
  }
  </template>
<flow>

See also

verify-signature()
Private Key Format