Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://rubydoc.info/github/cryptosphere/rbnacl/RbNaCl/SecretBoxes/XSalsa20Poly1305 below:

XSalsa20Poly1305 – Documentation for cryptosphere/rbnacl (main) – RubyDoc.info

Inherits:

Object

• Object
• RbNaCl::SecretBoxes::XSalsa20Poly1305

show all

Extended by:

RbNaCl::Sodium

Defined in:

lib/rbnacl/secret_boxes/xsalsa20poly1305.rb

The SecretBox class boxes and unboxes messages

This class uses the given secret key to encrypt and decrypt messages.

It is VITALLY important that the nonce is a nonce, i.e. it is a number used only once for any given pair of keys. If you fail to do this, you compromise the privacy of the messages encrypted. Give your nonces a different prefix, or have one side use an odd counter and one an even counter. Just make sure they are different.

The ciphertexts generated by this class include a 16-byte authenticator which is checked as part of the decryption. An invalid authenticator will cause the unbox function to raise. The authenticator is not a signature. Once you've looked in the box, you've demonstrated the ability to create arbitrary valid messages, so messages you send are repudiable. For non-repudiable messages, sign them before or after encryption.

• .key_bytes ⇒ Integer

  The key bytes for the SecretBox class.

• .nonce_bytes ⇒ Integer

  The nonce bytes for the SecretBox class.

• #box(nonce, message) ⇒ String (also: #encrypt)

  Encrypts a message.

• #initialize(key) ⇒ RbNaCl::SecretBox constructor

  Create a new SecretBox.

• #key_bytes ⇒ Integer

  The key bytes for the SecretBox instance.

• #nonce_bytes ⇒ Integer

  The nonce bytes for the SecretBox instance.

• #open(nonce, ciphertext) ⇒ String (also: #decrypt)

  Decrypts a ciphertext.

• #primitive ⇒ Symbol

  The crypto primitive for the SecretBox instance.

sodium_constant, sodium_function, sodium_function_with_return_code, sodium_primitive, sodium_type

Create a new SecretBox

Sets up the Box with a secret key fro encrypting and decrypting messages.

49
50
51

# File 'lib/rbnacl/secret_boxes/xsalsa20poly1305.rb', line 49

def initialize(key)
  @key = Util.check_string(key, KEYBYTES, "Secret key")
end

The key bytes for the SecretBox class

129
130
131

# File 'lib/rbnacl/secret_boxes/xsalsa20poly1305.rb', line 129

def self.key_bytes
  KEYBYTES
end

The nonce bytes for the SecretBox class

115
116
117

# File 'lib/rbnacl/secret_boxes/xsalsa20poly1305.rb', line 115

def self.nonce_bytes
  NONCEBYTES
end

Encrypts a message

Encrypts the message with the given nonce to the key set up when initializing the class. Make sure the nonce is unique for any given key, or you might as well just send plain text.

This function takes care of the padding required by the NaCL C API.

67
68
69
70
71
72
73
74
75
76

# File 'lib/rbnacl/secret_boxes/xsalsa20poly1305.rb', line 67

def box(nonce, message)
  Util.check_length(nonce, nonce_bytes, "Nonce")
  msg = Util.prepend_zeros(ZEROBYTES, message)
  ct  = Util.zeros(msg.bytesize)

  success = self.class.secretbox_xsalsa20poly1305(ct, msg, msg.bytesize, nonce, @key)
  raise CryptoError, "Encryption failed" unless success

  Util.remove_zeros(BOXZEROBYTES, ct)
end

The key bytes for the SecretBox instance

136
137
138

# File 'lib/rbnacl/secret_boxes/xsalsa20poly1305.rb', line 136

def key_bytes
  KEYBYTES
end

The nonce bytes for the SecretBox instance

122
123
124

# File 'lib/rbnacl/secret_boxes/xsalsa20poly1305.rb', line 122

def nonce_bytes
  NONCEBYTES
end

Decrypts a ciphertext

Decrypts the ciphertext with the given nonce using the key setup when initializing the class.

This function takes care of the padding required by the NaCL C API.

93
94
95
96
97
98
99
100
101
102

# File 'lib/rbnacl/secret_boxes/xsalsa20poly1305.rb', line 93

def open(nonce, ciphertext)
  Util.check_length(nonce, nonce_bytes, "Nonce")
  ct = Util.prepend_zeros(BOXZEROBYTES, ciphertext)
  message = Util.zeros(ct.bytesize)

  success = self.class.secretbox_xsalsa20poly1305_open(message, ct, ct.bytesize, nonce, @key)
  raise CryptoError, "Decryption failed. Ciphertext failed verification." unless success

  Util.remove_zeros(ZEROBYTES, message)
end

The crypto primitive for the SecretBox instance

108
109
110

# File 'lib/rbnacl/secret_boxes/xsalsa20poly1305.rb', line 108

def primitive
  self.class.primitive
end

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4