Class: Aws::EventBridgeV2::Types::WebhookHmacAuthConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb

Overview

The provider signs each request with a hash-based message authentication code (HMAC) of the secret. Amazon EventBridge accepts the request if any signature in SignatureHttpHeader matches.

Constant Summary collapse

SENSITIVE =
[:secret_value]

Instance Attribute Summary collapse

Instance Attribute Details

#algorithm ⇒ String

The hash algorithm the provider uses to compute the signature.

Returns:

  • (String)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#delimiter ⇒ String

The separator between parts of the signature header value, for example a comma for a header value of t=1727816400,v1=<signature>, or a space when the header carries several signatures. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.

Returns:

  • (String)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#encoding ⇒ String

How the provider encodes the signature in the header.

Returns:

  • (String)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#message_id_http_header ⇒ String

The name of the header that carries the message ID. Required when SignedMessageComposition is MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY. Requests whose message ID contains a period (.) are rejected. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.

Returns:

  • (String)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#secret_encoding ⇒ String

How the secret is encoded. RAW uses the secret's characters as the signing key. BASE64 decodes the secret first, as providers that follow the Standard Webhooks specification require. The default is RAW.

Returns:

  • (String)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#secret_value ⇒ String

The signing key shared with the provider. If you omit it, EventBridge generates one. EventBridge stores the key only in AWS Secrets Manager and never returns it, including from DescribeEventSource. The key must be 16 to 512 bytes; with BASE64 SecretEncoding, this is measured after decoding.

Returns:

  • (String)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#signature_http_header ⇒ String

The name of the header that carries the signature, for example X-Hub-Signature-256. When TimestampHttpHeader names the same header, Delimiter, SignaturePrefix and TimestampPrefix are all required. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.

Returns:

  • (String)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#signature_prefix ⇒ String

The text that precedes the signature in the header value, for example sha256=. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.

Returns:

  • (String)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#signed_message_composition ⇒ String

How the provider assembles the message it signs from the request.

  • BODY - The request body alone. BODY provides no replay protection.

  • TIMESTAMP_DOT_BODY - <timestamp>.<body>. Requires TimestampHttpHeader.

  • MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY - <messageId>.<timestamp>.<body>, as in the Standard Webhooks specification. Requires TimestampHttpHeader and MessageIdHttpHeader.

Returns:

  • (String)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#timestamp_http_header ⇒ String

The name of the header that carries the request timestamp. Required when SignedMessageComposition is TIMESTAMP_DOT_BODY or MESSAGE_ID_DOT_TIMESTAMP_DOT_BODY, or when TimestampToleranceInSeconds is set. Not allowed when SignedMessageComposition is BODY, because BODY does not sign the timestamp. Reserved names are rejected, as described on StaticTokenAuthConfiguration's TokenHttpHeader.

Returns:

  • (String)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#timestamp_prefix ⇒ String

The text that precedes the timestamp in the header value, for example t=. Required when TimestampHttpHeader is the same header as SignatureHttpHeader.

Returns:

  • (String)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end

#timestamp_tolerance_in_seconds ⇒ Integer

The maximum difference, in seconds, allowed between the request timestamp and the time EventBridge receives the request. Requests outside this window are rejected. The default is 300 seconds. Requires TimestampHttpHeader. Not allowed when SignedMessageComposition is BODY, because BODY does not sign the timestamp.

Returns:

  • (Integer)


3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
# File 'gems/aws-sdk-eventbridgev2/lib/aws-sdk-eventbridgev2/types.rb', line 3739

class WebhookHmacAuthConfiguration < Struct.new(
  :algorithm,
  :encoding,
  :signature_http_header,
  :signature_prefix,
  :delimiter,
  :timestamp_http_header,
  :timestamp_prefix,
  :timestamp_tolerance_in_seconds,
  :message_id_http_header,
  :signed_message_composition,
  :secret_value,
  :secret_encoding)
  SENSITIVE = [:secret_value]
  include Aws::Structure
end