SignalCommonCrypto

public struct SignalCommonCrypto

SignalCommonCrypto struct adopted from the LibSignalProtocolSwift project (lightly modified)


                    
                    
                    random(bytes:)

Create a number of random bytes

Throws

SignalError.noRandomBytes

Declaration

Swift

public static func random(bytes: Int) throws -> Data

Parameters


                                bytes

The number of random bytes to create

Return Value

An array of bytes length with random numbers

Show on GitHub


                    
                    
                    hmacSHA256(for:with:)

Create a HMAC authentication for a given message

Declaration

Swift

public static func hmacSHA256(for message: Data, with salt: Data) -> Data

Parameters

`message`	The input message to create the HMAC for
`salt`	The salt for the HMAC

Return Value

The HMAC

Show on GitHub


                    
                    
                    sha512(for:)

Create a SHA512 digest for a given message

Throws

SignalError.digestError

Declaration

Swift

public static func sha512(for message: Data) throws -> Data

Parameters


                                message

The input message to create the digest for

Return Value

The digest

Show on GitHub


                    
                    
                    encrypt(message:with:key:iv:)

Encrypt a message with AES

Throws

SignalError.encryptionError

Declaration

Swift

public static func encrypt(message: Data, with cipher: SignalEncryptionScheme = .AES_CBCwithPKCS5, key: Data, iv: Data) throws -> Data

Parameters

`message`	The input message to encrypt
`cipher`	THe encryption scheme to use
`key`	The key for encryption (`kCCKeySizeAES256` bytes)
`iv`	The initialization vector (`kCCBlockSizeAES128` bytes)

Return Value

The encrypted message

Show on GitHub


                    
                    
                    decrypt(message:with:key:iv:)

Decrypt a message with AES

Throws

SignalError.decryptionError

Declaration

Swift

public static func decrypt(message: Data, with cipher: SignalEncryptionScheme = .AES_CBCwithPKCS5, key: Data, iv: Data) throws -> Data

Parameters

`message`	The input message to decrypt
`cipher`	THe encryption scheme to use
`key`	The key for decryption (`kCCKeySizeAES256` bytes)
`iv`	The initialization vector (`kCCBlockSizeAES128` bytes)

Return Value

The decrypted message

Show on GitHub


                    
                    
                    verifyMAC(data:key:expectedMAC:)

Verify a message MAC

Declaration

Swift

public static func verifyMAC(data: Data, key: Data, expectedMAC: Data) throws

Show on GitHub


                    
                    
                    deriveSecrets(input:salt:info:chunks:)

RFC 5869 key derivation

Declaration

Swift

public static func deriveSecrets(input: Data, salt: Data = Data(count: 32), info: Data, chunks: Int = 2) throws -> [Data]

Show on GitHub


                    
                    
                    calculateAgreement(publicKeyData:privateKeyData:)

Calculate an ECDH agreement.

Declaration

Swift

public static func calculateAgreement(publicKeyData: Data, privateKeyData: Data) throws -> Data

Parameters

`publicKeyData`	The curve25519 (typically remote party’s) 32-byte public key data
`privateKeyData`	The curve25519 (typically your) 32-byte private key data

Return Value

a 32-bit shared secret on success, throwing on failure

Show on GitHub


                    
                    
                    generateKeyPairFromPrivateKey(privateKeyData:)

Generates a Curve25519 keypair.

Declaration

Swift

public static func generateKeyPairFromPrivateKey(privateKeyData: Data) throws -> KeyPair

Parameters


                                privateKeyData

The curve25519 (typically your) 32-byte private key data

Return Value

the full KeyPair

Show on GitHub

generateSignature(privateKeyData:message:)
Generate a Curve25519 signature.
Declaration
Swift

public static func generateSignature(privateKeyData: Data, message: Data) throws -> Data
Show on GitHub


                    
                    
                    verifySignature(signature:publicKeyData:message:)

Validate a Curve25519 signature.

Declaration

Swift

public static func verifySignature(signature: Data, publicKeyData: Data, message: Data) throws -> Bool

Show on GitHub


                    
                    
                    decryptAttachment(data:keys:)

Decrypt attachment data

Declaration

Swift

public static func decryptAttachment(data: Data, keys: Data) throws -> Data

Show on GitHub


                    
                    
                    encryptAttachment(data:keys:iv:)

Encrypt attachment data

Declaration

Swift

public static func encryptAttachment(data: Data, keys: Data, iv: Data) throws -> Data

Show on GitHub