Skip to content

Feat: new crypto methods #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 6, 2025
Merged

Feat: new crypto methods #40

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
952f01c
Cxx wrapper
Drejzer Apr 29, 2025
8b8118f
New error cases for cryptoApi methods
Drejzer Apr 29, 2025
d88f2b1
missing error case
Drejzer Apr 30, 2025
0fbde61
Added Swift part of the wrapper for the new methods.
Drejzer Apr 30, 2025
12f7e70
Added docs for the new methods (copied from cpp) + code fix
Drejzer Apr 30, 2025
2575bc5
corrected throw error case in conversin method
Drejzer May 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
177 changes: 177 additions & 0 deletions Sources/PrivMXEndpointSwift/Crypto/CryptoApi.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,5 +350,182 @@ public class CryptoApi{
}


/// Converts given public key in PGP format to its base58DER format.
///
/// - Parameter pgpKey: public key to convert
///
/// - Throws: `PrivMXEndpointError.failedConvertingKeyToBase58DER` if the conversion fails.
///
/// - Returns: public key in base58DER format
public func convertPGPAsn1KeyToBase58DERKey(
pgpKey: std.string
) throws -> std.string {
let res = api.convertPGPAsn1KeyToBase58DERKey(pgpKey)
guard res.error.value == nil else {
throw PrivMXEndpointError.failedConvertingKeyToBase58DER(res.error.value!)
}
guard let result = res.result.value else {
var err = privmx.InternalError()
err.name = "Value error"
err.description = "Unexpectedly recived nil result"
throw PrivMXEndpointError.failedConvertingKeyToBase58DER(err)
}
return result
}


/// Generates ECC key and BIP-39 mnemonic from a password using BIP-39.
///
/// - Parameter strength: size of BIP-39 entropy, must be a multiple of 32
/// - Parameter password: the password used to generate the Key
///
/// - Throws: `PrivMXEndpointError.failedGeneratingBIP39` if the generating fails.
///
/// - Returns: `BIP39_t` object containing ECC Key and associated with it BIP-39 mnemonic and entropy
public func generateBip39(
strength: size_t,
password: std.string = std.string()
) throws -> privmx.endpoint.crypto.BIP39_t {
let res = api.generateBip39(strength,
password)
guard res.error.value == nil else {
throw PrivMXEndpointError.failedGeneratingBIP39(res.error.value!)
}
guard let result = res.result.value else {
var err = privmx.InternalError()
err.name = "Value error"
err.description = "Unexpectedly recived nil result"
throw PrivMXEndpointError.failedGeneratingBIP39(err)
}
return result
}


/// Generates ECC key using BIP-39 mnemonic.
///
/// - Parameters mnemonic: the BIP-39 entropy used to generate the Key
/// - Parameters mnemonic: the password used to generate the Key
///
/// - Throws: `PrivMXEndpointError.failedGeneratingBIP39` if the generating fails.
///
/// - Returns: `BIP39_t` object containing ECC Key and associated with it BIP-39 mnemonic and entropy
public func fromMnemonic(
mnemonic: std.string,
password: std.string = std.string()
) throws -> privmx.endpoint.crypto.BIP39_t {
let res = api.fromMnemonic(mnemonic,
password)
guard res.error.value == nil else {
throw PrivMXEndpointError.failedGeneratingBIP39(res.error.value!)
}
guard let result = res.result.value else {
var err = privmx.InternalError()
err.name = "Value error"
err.description = "Unexpectedly recived nil result"
throw PrivMXEndpointError.failedGeneratingBIP39(err)
}
return result
}


/// Generates ECC key using BIP-39 entropy.
///
/// - Parameters entropy: the BIP-39 entropy used to generate the Key
/// - Parameters password: the password used to generate the Key
///
/// - Throws: `PrivMXEndpointError.failedGeneratingBIP39` if the generating fails.
///
/// - Returns: `BIP39_t` object containing ECC Key and associated with it BIP-39 mnemonic and entropy
public func fromEntropy(
entropy: privmx.endpoint.core.Buffer,
password: std.string = std.string()
)throws -> privmx.endpoint.crypto.BIP39_t{
let res = api.fromEntropy(entropy,
password)
guard res.error.value == nil else {
throw PrivMXEndpointError.failedGeneratingBIP39(res.error.value!)
}
guard let result = res.result.value else {
var err = privmx.InternalError()
err.name = "Value error"
err.description = "Unexpectedly recived nil result"
throw PrivMXEndpointError.failedGeneratingBIP39(err)
}
return result
}


/// Converts BIP-39 mnemonic to entropy.
///
/// - Parameter entropy: BIP-39 entropy
///
/// - Throws: `PrivMXEndpointError.failedConvertingEntropyToMnemonic` if the conversion fails.
///
/// - Returns: BIP-39 mnemonic
public func entropyToMnemonic(
entropy: privmx.endpoint.core.Buffer
) throws -> std.string {
let res = api.entropyToMnemonic(entropy)
guard res.error.value == nil else {
throw PrivMXEndpointError.failedConvertingEntropyToMnemonic(res.error.value!)
}
guard let result = res.result.value else {
var err = privmx.InternalError()
err.name = "Value error"
err.description = "Unexpectedly recived nil result"
throw PrivMXEndpointError.failedConvertingEntropyToMnemonic(err)
}
return result
}


/// Converts BIP-39 mnemonic to entropy.
///
/// - Parameter mnemonic: BIP-39 mnemonic
///
/// - Throws: `PrivMXEndpointError.failedConvertingMnemonicToEntropy` if the conversion fails.
///
/// - Returns: BIP-39 entropy
public func mnemonicToEntropy(
mnemonic: std.string
) throws -> privmx.endpoint.core.Buffer {
let res = api.mnemonicToEntropy(mnemonic)
guard res.error.value == nil else {
throw PrivMXEndpointError.failedConvertingMnemonicToEntropy(res.error.value!)
}
guard let result = res.result.value else {
var err = privmx.InternalError()
err.name = "Value error"
err.description = "Unexpectedly recived nil result"
throw PrivMXEndpointError.failedConvertingMnemonicToEntropy(err)
}
return result
}


/// Generates a seed used to generate a key using BIP-39 mnemonic with PBKDF2.
///
/// - Parameters mnemonic: BIP-39 mnemonic
/// - Parameters password: the password used to generate the seed
///
/// - Throws: `PrivMXEndpointError.failedGeneratingSeedFromMnemonic` if the generating fails.
///
/// - Returns: generated seed
public func mnemonicToSeed(
mnemonic: std.string,
password: std.string = std.string()
) throws -> privmx.endpoint.core.Buffer {
let res = api.mnemonicToSeed(mnemonic,
password)
guard res.error.value == nil else {
throw PrivMXEndpointError.failedGeneratingSeedFromMnemonic(res.error.value!)
}
guard let result = res.result.value else {
var err = privmx.InternalError()
err.name = "Value error"
err.description = "Unexpectedly recived nil result"
throw PrivMXEndpointError.failedGeneratingSeedFromMnemonic(err)
}
return result
}
}
45 changes: 41 additions & 4 deletions Sources/PrivMXEndpointSwift/Errors/PrivMXEndpointError.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,23 @@ public enum PrivMXEndpointError : Error{

case FailedSettingUserVerifier(privmx.InternalError)

/// Failed to convert a PGP Asn1 key to Base58DER
case failedConvertingKeyToBase58DER(privmx.InternalError)

/// Failed to generate a BIP39 instance
case failedGeneratingBIP39(privmx.InternalError)

/// Failed to convert Entropy to a Mnemonic
case failedConvertingEntropyToMnemonic(privmx.InternalError)

/// Failed to convert a Mnemonic to Entropy
case failedConvertingMnemonicToEntropy(privmx.InternalError)

/// Failed to generate a Seed for BIP39 Key from a Mnemonic
case failedGeneratingSeedFromMnemonic(privmx.InternalError)



/// Gets the Message of the error
///
/// - Returns: Message of the error
Expand Down Expand Up @@ -248,7 +265,12 @@ public enum PrivMXEndpointError : Error{
.FailedEmittingCustomEvent(let err),
.FailedSubscribingForCustomEvents(let err),
.FailedUnsubscribingFromCustomEvents(let err),
.FailedSettingUserVerifier(let err):
.FailedSettingUserVerifier(let err),
.failedConvertingKeyToBase58DER(let err),
.failedConvertingEntropyToMnemonic(let err),
.failedConvertingMnemonicToEntropy(let err),
.failedGeneratingSeedFromMnemonic(let err),
.failedGeneratingBIP39(let err):
return String(err.message)
}
}
Expand Down Expand Up @@ -326,7 +348,12 @@ public enum PrivMXEndpointError : Error{
.FailedEmittingCustomEvent(let err),
.FailedSubscribingForCustomEvents(let err),
.FailedUnsubscribingFromCustomEvents(let err),
.FailedSettingUserVerifier(let err):
.FailedSettingUserVerifier(let err),
.failedConvertingKeyToBase58DER(let err),
.failedConvertingEntropyToMnemonic(let err),
.failedConvertingMnemonicToEntropy(let err),
.failedGeneratingSeedFromMnemonic(let err),
.failedGeneratingBIP39(let err):
return err.code.value
}
}
Expand Down Expand Up @@ -404,7 +431,12 @@ public enum PrivMXEndpointError : Error{
.FailedEmittingCustomEvent(let err),
.FailedSubscribingForCustomEvents(let err),
.FailedUnsubscribingFromCustomEvents(let err),
.FailedSettingUserVerifier(let err):
.FailedSettingUserVerifier(let err),
.failedConvertingKeyToBase58DER(let err),
.failedConvertingEntropyToMnemonic(let err),
.failedConvertingMnemonicToEntropy(let err),
.failedGeneratingSeedFromMnemonic(let err),
.failedGeneratingBIP39(let err):
return String(err.name)
}
}
Expand Down Expand Up @@ -481,7 +513,12 @@ public enum PrivMXEndpointError : Error{
.FailedEmittingCustomEvent(let err),
.FailedSubscribingForCustomEvents(let err),
.FailedUnsubscribingFromCustomEvents(let err),
.FailedSettingUserVerifier(let err):
.FailedSettingUserVerifier(let err),
.failedConvertingKeyToBase58DER(let err),
.failedConvertingEntropyToMnemonic(let err),
.failedConvertingMnemonicToEntropy(let err),
.failedGeneratingSeedFromMnemonic(let err),
.failedGeneratingBIP39(let err):
return String(err.description)
}
}
Expand Down
Loading