Module: Faraday::HttpSignature

Defined in:
lib/faraday/http_signature.rb,
lib/faraday/http_signature/middleware.rb

Overview

Faraday middleware for signing and verifying HTTP messages as defined in RFC 9421.

Three registration points are provided so the middleware can be added via request, response or use, each with appropriate defaults:

Examples:

Sign outgoing requests

conn = Faraday.new(url: "https://example.com") do |f|
  f.request :http_signature, key: my_key, components: %w[@method @path]
end

Verify incoming responses

conn = Faraday.new(url: "https://example.com") do |f|
  f.response :http_signature, verify_key: server_pubkey
end

Sign requests and verify responses

conn = Faraday.new(url: "https://example.com") do |f|
  f.use :http_signature, sign_key: my_key, verify_key: server_pubkey,
    verify_response: true, components: %w[@method @path]
end

See Also:

Defined Under Namespace

Classes: Middleware, SigningError, VerifyError