Class: FactPulse::SignatureParameters

Inherits:
ApiModelBase show all
Defined in:
lib/factpulse/models/signature_parameters.rb

Overview

Optional parameters to sign the generated PDF. **MODE 1 - Stored certificate (recommended):** Only provide metadata (reason, location, etc.). The certificate will be automatically retrieved via client_uid from JWT. eIDAS compliant PAdES-B-LT signature. **MODE 2 - Keys in payload (tests/special cases):** Provide key_pem + cert_pem directly in the payload. Accepted PEM format: raw ("—–BEGIN…") or base64. **Selection rule:** - If key_pem AND cert_pem provided → Mode 2 (payload keys) - Otherwise → Mode 1 (stored certificate retrieved via client_uid)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SignatureParameters

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/factpulse/models/signature_parameters.rb', line 94

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::SignatureParameters` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::SignatureParameters`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'key_pem')
    self.key_pem = attributes[:'key_pem']
  end

  if attributes.key?(:'cert_pem')
    self.cert_pem = attributes[:'cert_pem']
  end

  if attributes.key?(:'key_passphrase')
    self.key_passphrase = attributes[:'key_passphrase']
  end

  if attributes.key?(:'reason')
    self.reason = attributes[:'reason']
  end

  if attributes.key?(:'location')
    self.location = attributes[:'location']
  end

  if attributes.key?(:'contact')
    self.contact = attributes[:'contact']
  end

  if attributes.key?(:'field_name')
    self.field_name = attributes[:'field_name']
  else
    self.field_name = 'FactPulseSignature'
  end

  if attributes.key?(:'use_pades_lt')
    self.use_pades_lt = attributes[:'use_pades_lt']
  else
    self.use_pades_lt = false
  end

  if attributes.key?(:'use_timestamp')
    self.use_timestamp = attributes[:'use_timestamp']
  else
    self.use_timestamp = true
  end
end

Instance Attribute Details

#cert_pem ⇒ Object

Returns the value of attribute cert_pem.



21
22
23
 
# File 'lib/factpulse/models/signature_parameters.rb', line 21

def cert_pem
  @cert_pem
end

#contact ⇒ Object

Returns the value of attribute contact.



29
30
31
 
# File 'lib/factpulse/models/signature_parameters.rb', line 29

def contact
  @contact
end

#field_name ⇒ Object

PDF signature field name



32
33
34
 
# File 'lib/factpulse/models/signature_parameters.rb', line 32

def field_name
  @field_name
end

#key_passphrase ⇒ Object

Returns the value of attribute key_passphrase.



23
24
25
 
# File 'lib/factpulse/models/signature_parameters.rb', line 23

def key_passphrase
  @key_passphrase
end

#key_pem ⇒ Object

Returns the value of attribute key_pem.



19
20
21
 
# File 'lib/factpulse/models/signature_parameters.rb', line 19

def key_pem
  @key_pem
end

#location ⇒ Object

Returns the value of attribute location.



27
28
29
 
# File 'lib/factpulse/models/signature_parameters.rb', line 27

def location
  @location
end

#reason ⇒ Object

Returns the value of attribute reason.



25
26
27
 
# File 'lib/factpulse/models/signature_parameters.rb', line 25

def reason
  @reason
end

#use_pades_lt ⇒ Object

Enable PAdES-B-LT (long-term archival). REQUIRES certificate with OCSP/CRL access



35
36
37
 
# File 'lib/factpulse/models/signature_parameters.rb', line 35

def use_pades_lt
  @use_pades_lt
end

#use_timestamp ⇒ Object

Enable RFC 3161 timestamping with FreeTSA (PAdES-B-T)



38
39
40
 
# File 'lib/factpulse/models/signature_parameters.rb', line 38

def use_timestamp
  @use_timestamp
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



56
57
58
 
# File 'lib/factpulse/models/signature_parameters.rb', line 56

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/factpulse/models/signature_parameters.rb', line 61

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/factpulse/models/signature_parameters.rb', line 41

def self.attribute_map
  {
    :'key_pem' => :'keyPem',
    :'cert_pem' => :'certPem',
    :'key_passphrase' => :'keyPassphrase',
    :'reason' => :'reason',
    :'location' => :'location',
    :'contact' => :'contact',
    :'field_name' => :'fieldName',
    :'use_pades_lt' => :'usePadesLt',
    :'use_timestamp' => :'useTimestamp'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/factpulse/models/signature_parameters.rb', line 197

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/factpulse/models/signature_parameters.rb', line 81

def self.openapi_nullable
  Set.new([
    :'key_pem',
    :'cert_pem',
    :'key_passphrase',
    :'reason',
    :'location',
    :'contact',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/factpulse/models/signature_parameters.rb', line 66

def self.openapi_types
  {
    :'key_pem' => :'String',
    :'cert_pem' => :'String',
    :'key_passphrase' => :'String',
    :'reason' => :'String',
    :'location' => :'String',
    :'contact' => :'String',
    :'field_name' => :'String',
    :'use_pades_lt' => :'Boolean',
    :'use_timestamp' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/factpulse/models/signature_parameters.rb', line 168

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      key_pem == o.key_pem &&
      cert_pem == o.cert_pem &&
      key_passphrase == o.key_passphrase &&
      reason == o.reason &&
      location == o.location &&
      contact == o.contact &&
      field_name == o.field_name &&
      use_pades_lt == o.use_pades_lt &&
      use_timestamp == o.use_timestamp
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


184
185
186
 
# File 'lib/factpulse/models/signature_parameters.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



190
191
192
 
# File 'lib/factpulse/models/signature_parameters.rb', line 190

def hash
  [key_pem, cert_pem, key_passphrase, reason, location, contact, field_name, use_pades_lt, use_timestamp].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



153
154
155
156
157
 
# File 'lib/factpulse/models/signature_parameters.rb', line 153

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/factpulse/models/signature_parameters.rb', line 219

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



161
162
163
164
 
# File 'lib/factpulse/models/signature_parameters.rb', line 161

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end