Class: JSON::JWE

Inherits:
JOSE
  • Object
show all
Defined in:
lib/json/jwe.rb

Defined Under Namespace

Classes: DecryptionFailed, InvalidFormat, UnexpectedAlgorithm

Constant Summary collapse

NUM_OF_SEGMENTS = 
5

Instance Attribute Summary collapse

Attributes inherited from JWT

#header, #signature

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from JWT

decode, #encrypt, register_header_keys, #sign, #verify

Constructor Details

#initialize(input = nil) ⇒ JWE

Returns a new instance of JWE.



21
22
23
 
# File 'lib/json/jwe.rb', line 21

def initialize(input = nil)
  self.plain_text = input.to_s
end

Instance Attribute Details

#auth_data ⇒ Object

Returns the value of attribute auth_data.



12
13
14
 
# File 'lib/json/jwe.rb', line 12

def auth_data
  @auth_data
end

#authentication_tag=(value) ⇒ Object

Sets the attribute authentication_tag

Parameters:

  • value —

    the value to set the attribute authentication_tag to.



12
13
14
 
# File 'lib/json/jwe.rb', line 12

def authentication_tag=(value)
  @authentication_tag = value
end

#cipher_text ⇒ Object

Returns the value of attribute cipher_text.



12
13
14
 
# File 'lib/json/jwe.rb', line 12

def cipher_text
  @cipher_text
end

#content_encryption_key ⇒ Object

Returns the value of attribute content_encryption_key.



12
13
14
 
# File 'lib/json/jwe.rb', line 12

def content_encryption_key
  @content_encryption_key
end

#encryption_key ⇒ Object

Returns the value of attribute encryption_key.



12
13
14
 
# File 'lib/json/jwe.rb', line 12

def encryption_key
  @encryption_key
end

#iv ⇒ Object

Returns the value of attribute iv.



12
13
14
 
# File 'lib/json/jwe.rb', line 12

def iv
  @iv
end

#jwe_encrypted_key=(value) ⇒ Object

Sets the attribute jwe_encrypted_key

Parameters:

  • value —

    the value to set the attribute jwe_encrypted_key to.



12
13
14
 
# File 'lib/json/jwe.rb', line 12

def jwe_encrypted_key=(value)
  @jwe_encrypted_key = value
end

#mac_key ⇒ Object

Returns the value of attribute mac_key.



12
13
14
 
# File 'lib/json/jwe.rb', line 12

def mac_key
  @mac_key
end

#plain_text ⇒ Object

Returns the value of attribute plain_text.



12
13
14
 
# File 'lib/json/jwe.rb', line 12

def plain_text
  @plain_text
end

#private_key_or_secret ⇒ Object

Returns the value of attribute private_key_or_secret.



12
13
14
 
# File 'lib/json/jwe.rb', line 12

def private_key_or_secret
  @private_key_or_secret
end

#public_key_or_secret ⇒ Object

Returns the value of attribute public_key_or_secret.



12
13
14
 
# File 'lib/json/jwe.rb', line 12

def public_key_or_secret
  @public_key_or_secret
end

Class Method Details

.decode_compact_serialized(input, private_key_or_secret) ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/json/jwe.rb', line 287

def decode_compact_serialized(input, private_key_or_secret)
  unless input.count('.') + 1 == NUM_OF_SEGMENTS
    raise InvalidFormat.new("Invalid JWE Format. JWE should include #{NUM_OF_SEGMENTS} segments.")
  end
  jwe = new
  _header_json_, jwe.jwe_encrypted_key, jwe.iv, jwe.cipher_text, jwe.authentication_tag = input.split('.').collect do |segment|
    UrlSafeBase64.decode64 segment
  end
  jwe.auth_data = input.split('.').first
  jwe.header = MultiJson.load(_header_json_).with_indifferent_access
  jwe.decrypt! private_key_or_secret unless private_key_or_secret == :skip_decryption
  jwe
end

.decode_json_serialized(input, private_key_or_secret) ⇒ Object 



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/json/jwe.rb', line 301

def decode_json_serialized(input, private_key_or_secret)
  input = input.with_indifferent_access
  jwe_encrypted_key = if input[:recipients].present?
    input[:recipients].first[:encrypted_key]
  else
    input[:encrypted_key]
  end
  compact_serialized = [
    input[:protected],
    jwe_encrypted_key,
    input[:iv],
    input[:ciphertext],
    input[:tag]
  ].join('.')
  decode_compact_serialized compact_serialized, private_key_or_secret
end

Instance Method Details

#as_json(options = {}) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/json/jwe.rb', line 58

def as_json(options = {})
  case options[:syntax]
  when :general
    {
      protected:  UrlSafeBase64.encode64(header.to_json),
      recipients: [{
        encrypted_key: UrlSafeBase64.encode64(jwe_encrypted_key)
      }],
      iv:         UrlSafeBase64.encode64(iv),
      ciphertext: UrlSafeBase64.encode64(cipher_text),
      tag:        UrlSafeBase64.encode64(authentication_tag)
    }
  when :flattened
    {
      protected:     UrlSafeBase64.encode64(header.to_json),
      encrypted_key: UrlSafeBase64.encode64(jwe_encrypted_key),
      iv:            UrlSafeBase64.encode64(iv),
      ciphertext:    UrlSafeBase64.encode64(cipher_text),
      tag:           UrlSafeBase64.encode64(authentication_tag)
    }
  else
    super
  end
end

#content_type ⇒ Object 



25
26
27
 
# File 'lib/json/jwe.rb', line 25

def content_type
  'application/jose'
end

#decrypt!(private_key_or_secret) ⇒ Object 



37
38
39
40
41
42
43
44
 
# File 'lib/json/jwe.rb', line 37

def decrypt!(private_key_or_secret)
  self.private_key_or_secret = private_key_or_secret
  cipher.decrypt
  restore_cipher_keys!
  self.plain_text = cipher.update(cipher_text) + cipher.final
  verify_cbc_authentication_tag! if cbc?
  self
end

#encrypt!(public_key_or_secret) ⇒ Object 



29
30
31
32
33
34
35
 
# File 'lib/json/jwe.rb', line 29

def encrypt!(public_key_or_secret)
  self.public_key_or_secret = public_key_or_secret
  cipher.encrypt
  generate_cipher_keys!
  self.cipher_text = cipher.update(plain_text) + cipher.final
  self
end

#to_s ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/json/jwe.rb', line 46

def to_s
  [
    header.to_json,
    jwe_encrypted_key,
    iv,
    cipher_text,
    authentication_tag
  ].collect do |segment|
    UrlSafeBase64.encode64 segment.to_s
  end.join('.')
end