Class: Linzer::Signature::Profile::Base Abstract

Inherits:
Object
  • Object
show all
Defined in:
lib/linzer/signature/profile/base.rb

Overview

This class is abstract.

Base class for all signing profiles.

A signing profile encapsulates policy logic that can modify a Context before signature generation.

Subclasses are expected to implement #apply.

## Lifecycle

  1. Context is created

  2. Profile is resolved via resolve

  3. #apply is invoked with the signing context

  4. Context is used to generate signature

Direct Known Subclasses

Example, WebBotAuth

Instance Method Summary collapse

Instance Method Details

#apply(ctx) ⇒ void

This method returns an undefined value.

Applies the profile to a signing context.

Implementations may:

  • modify context parameters

  • inject overlay headers

  • adjust covered components

Parameters:

Raises:

  • (Linzer::Error)

    If the subclass does not implement this method



37
38
39
# File 'lib/linzer/signature/profile/base.rb', line 37

def apply(ctx)
  raise Error, "Sub-classes are required to implement this method!"
end