Sodium Structure Reference

init()
This initializes libsodium.

See
libsodium Usage
Declaration
Swift

fileprivate init()
Show on GitHub

Generic Hashing

generichash
Access to the wrapper for generic hashing.
Declaration
Swift

let generichash: Sodium.SodiumGenericHash
Show on GitHub
SodiumGenericHash
A wrapper for generic hashing.
See more
Declaration
Swift

struct SodiumGenericHash
Show on GitHub

Key Derivation

kdf
Access to the key derivation wrapper.
Declaration
Swift

let kdf: Sodium.SodiumKeyDerivation
Show on GitHub
SodiumKeyDerivation
A wrapper for key derivation.
See more
Declaration
Swift

struct SodiumKeyDerivation
Show on GitHub

Key Exchange

kx
Access to the wrapper for key exchange.
Declaration
Swift

let kx: Sodium.SodiumKeyExchange
Show on GitHub
SodiumKeyExchange
A wrapper for key exchange.
See more
Declaration
Swift

struct SodiumKeyExchange
Show on GitHub

Memory

memory
Access to the secure memory wrapper.
Declaration
Swift

let memory: Sodium.SodiumMemory
Show on GitHub
SodiumMemory
A wrapper for handling secure memory allocations.

See
libsodium: Securing memory allocations
See more
Declaration
Swift

struct SodiumMemory
Show on GitHub

Password Hashing

pwhash
Access to the password hashing wrapper
Declaration
Swift

let pwhash: Sodium.SodiumPasswordHash
Show on GitHub
SodiumPasswordHash
A wrapper for password hashing.
See more
Declaration
Swift

struct SodiumPasswordHash
Show on GitHub

Random

random
Access to the wrapper for secure random byte generation.
Declaration
Swift

let random: Sodium.SodiumRandom
Show on GitHub
SodiumRandom
A wrapper for generating random bytes securely.
See more
Declaration
Swift

struct SodiumRandom
Show on GitHub

Symmetric Encryption (SecretBox)

secretbox
Access to the secret box wrapper.
Declaration
Swift

let secretbox: Sodium.SodiumSecretBox
Show on GitHub
SodiumSecretBox
A wrapper for symmetric encryption.
See more
Declaration
Swift

struct SodiumSecretBox
Show on GitHub

Padding


                    
                    
                    pad(unpadded:blockSize:)

Add padding to protect message lengths.

Warning

Padding has to be applied to plaintext before encryption.

Precondition

0 < blockSize

Postcondition

result.count % blockSize = 0

Declaration

Swift

func pad(unpadded: Bytes, blockSize: Int) -> Bytes

Parameters

`unpadded`	The unpadded plaintext bytes.
`blockSize`	The block size in bytes.

Return Value

The padded plaintext bytes.

Show on GitHub


                    
                    
                    unpad(padded:blockSize:)

Add padding to protect message lengths.

Warning

Padding has to be applied to plaintext before encryption.

Precondition

0 < blockSize

Postcondition

result.count % blockSize = 0

Declaration

Swift

func unpad(padded: Bytes, blockSize: Int) -> Bytes?

Parameters

`unpadded`	The unpadded plaintext bytes.
`blockSize`	The block size in bytes.

Return Value

The padded plaintext bytes.

Show on GitHub

Utilities


                    
                    
                    hex2bin(_:ignore:)

Converts hex-characters to a byte array.

Declaration

Swift

func hex2bin(_ hex: String, ignore: String? = nil) -> Bytes?

Parameters

`hex`	The string.
`ignore`	A string containing characters that should be ignored, e.g., this is useful to ignore the colon if `hex` is 00:11.

Return Value

The byte array.

Show on GitHub


                    
                    
                    bin2hex(_:)

Converts a byte array to a hex-encoded string.

Declaration

Swift

func bin2hex(_ bin: Bytes) -> String

Parameters

bin

The byte array.

Return Value

The hex-encoded string.

Show on GitHub


                    
                    
                    b64decode(_:ignore:)

Converts hex-characters to a byte array.

Declaration

Swift

func b64decode(_ b64: String, ignore: String? = nil) -> Bytes?

Parameters

`b64`	The string.
`ignore`	A string containing characters that should be ignored.

Return Value

The byte array.

Show on GitHub


                    
                    
                    b64encode(bytes:)

Converts a byte array to a Base64-encoded string.

Declaration

Swift

func b64encode(bytes: Bytes) -> String

Parameters

bin

The byte array.

Return Value

The Base64-encoded string.

Show on GitHub