feat(anoncreds): add support for anoncreds issuance flow

Fixes ATL-4294

AtalaPrismSDK/Apollo/Sources/ApolloImpl+KeyRestoration.swift

@@ -10,29 +10,30 @@ extension ApolloImpl: KeyRestoration {
  identifier.hasSuffix("pub")
  }
 
- public func restorePrivateKey(identifier: String?, data: Data) throws -> PrivateKey {
- guard let identifier else { throw ApolloError.restoratonFailedNoIdentifierOrInvalid }
- switch identifier {
+ public func restorePrivateKey(_ key: StorableKey) throws -> PrivateKey {
+ switch key.restorationIdentifier {
  case "secp256k1+priv":
- return Secp256k1PrivateKey(lockedPrivateKey: .init(data: data))
+ return Secp256k1PrivateKey(
+ lockedPrivateKey: .init(data: key.storableData),
+ derivationPath: key.index.map { DerivationPath(index: $0) } ?? DerivationPath(index: 0)
+ )
  case "x25519+priv":
- return X25519PrivateKey(appleCurve: try .init(rawRepresentation: data))
+ return X25519PrivateKey(appleCurve: try .init(rawRepresentation: key.storableData))
  case "ed25519+priv":
- return Ed25519PrivateKey(appleCurve: try .init(rawRepresentation: data))
+ return Ed25519PrivateKey(appleCurve: try .init(rawRepresentation: key.storableData))
  default:
  throw ApolloError.restoratonFailedNoIdentifierOrInvalid
  }
  }
 
- public func restorePublicKey(identifier: String?, data: Data) throws -> PublicKey {
- guard let identifier else { throw ApolloError.restoratonFailedNoIdentifierOrInvalid }
- switch identifier {
+ public func restorePublicKey(_ key: StorableKey) throws -> PublicKey {
+ switch key.restorationIdentifier {
  case "secp256k1+pub":
- return Secp256k1PublicKey(lockedPublicKey: .init(bytes: data))
+ return Secp256k1PublicKey(lockedPublicKey: .init(bytes: key.storableData))
  case "x25519+pub":
- return X25519PublicKey(appleCurve: try .init(rawRepresentation: data))
+ return X25519PublicKey(appleCurve: try .init(rawRepresentation: key.storableData))
  case "ed25519+pub":
- return Ed25519PublicKey(appleCurve: try .init(rawRepresentation: data))
+ return Ed25519PublicKey(appleCurve: try .init(rawRepresentation: key.storableData))
  default:
  throw ApolloError.restoratonFailedNoIdentifierOrInvalid
  }

AtalaPrismSDK/Apollo/Sources/ApolloImpl+Public.swift

@@ -102,9 +102,11 @@ returns random mnemonics nerver returns invalid mnemonics
  switch curve {
  case .secp256k1:
  if
- let keyData = parameters[KeyProperties.rawKey.rawValue].flatMap({ Data(base64Encoded: $0) })
+ let keyData = parameters[KeyProperties.rawKey.rawValue].flatMap({ Data(base64Encoded: $0) }),
+ let derivationPathStr = parameters[KeyProperties.derivationPath.rawValue]
  {
- return Secp256k1PrivateKey(lockedPrivateKey: .init(data: keyData))
+ let derivationPath = try DerivationPath(string: derivationPathStr)
+ return Secp256k1PrivateKey(lockedPrivateKey: .init(data: keyData), derivationPath: derivationPath)
  } else {
  guard
  let derivationPathStr = parameters[KeyProperties.derivationPath.rawValue],
@@ -143,7 +145,7 @@ returns random mnemonics nerver returns invalid mnemonics
  }
  }
 
- public func createNewLinkSecret() -> String {
- CreateLinkSecretOperation().create()
+ public func createNewLinkSecret() throws -> String {
+ try CreateLinkSecretOperation().create()
  }
 }

AtalaPrismSDK/Apollo/Sources/Model/Ed25519Key.swift

@@ -35,6 +35,7 @@ extension Ed25519PrivateKey: SignableKey {
 extension Ed25519PrivateKey: KeychainStorableKey {
  var restorationIdentifier: String { "ed25519+priv" }
  var storableData: Data { raw }
+ var index: Int? { nil }
  var type: Domain.KeychainStorableKeyProperties.KeyAlgorithm { .rawKey }
  var keyClass: Domain.KeychainStorableKeyProperties.KeyType { .privateKey }
  var accessiblity: Domain.KeychainStorableKeyProperties.Accessability? { .firstUnlock(deviceOnly: true) }
@@ -62,6 +63,7 @@ struct Ed25519PublicKey: PublicKey {
 extension Ed25519PublicKey: KeychainStorableKey {
  var restorationIdentifier: String { "ed25519+pub" }
  var storableData: Data { raw }
+ var index: Int? { nil }
  var type: Domain.KeychainStorableKeyProperties.KeyAlgorithm { .rawKey }
  var keyClass: Domain.KeychainStorableKeyProperties.KeyType { .publicKey }
  var accessiblity: Domain.KeychainStorableKeyProperties.Accessability? { .firstUnlock(deviceOnly: true) }

AtalaPrismSDK/Apollo/Sources/Model/Secp256k1Key.swift

@@ -9,11 +9,14 @@ struct Secp256k1PrivateKey: PrivateKey {
  let keySpecifications: [String : String]
  let size: Int
  let raw: Data
+ let derivationPath: DerivationPath
 
- init(lockedPrivateKey: LockPrivateKey) {
+ init(lockedPrivateKey: LockPrivateKey, derivationPath: DerivationPath) {
  self.lockedPrivateKey = lockedPrivateKey
+ self.derivationPath = derivationPath
  self.keySpecifications = [
- KeyProperties.curve.rawValue : "secp256k1"
+ KeyProperties.curve.rawValue : "secp256k1",
+ KeyProperties.derivationPath.rawValue : derivationPath.keyPathString()
  ]
 
  self.raw = lockedPrivateKey.data
@@ -40,6 +43,7 @@ extension Secp256k1PrivateKey: SignableKey {
 extension Secp256k1PrivateKey: KeychainStorableKey {
  var restorationIdentifier: String { "secp256k1+priv" }
  var storableData: Data { raw }
+ var index: Int? { derivationPath.index }
  var type: Domain.KeychainStorableKeyProperties.KeyAlgorithm { .rawKey }
  var keyClass: Domain.KeychainStorableKeyProperties.KeyType { .privateKey }
  var accessiblity: Domain.KeychainStorableKeyProperties.Accessability? { .firstUnlock(deviceOnly: true) }
@@ -81,6 +85,7 @@ struct Secp256k1PublicKey: PublicKey {
 extension Secp256k1PublicKey: KeychainStorableKey {
  var restorationIdentifier: String { "secp256k1+pub" }
  var storableData: Data { raw }
+ var index: Int? { nil }
  var type: Domain.KeychainStorableKeyProperties.KeyAlgorithm { .rawKey }
  var keyClass: Domain.KeychainStorableKeyProperties.KeyType { .publicKey }
  var accessiblity: Domain.KeychainStorableKeyProperties.Accessability? { .firstUnlock(deviceOnly: true) }

AtalaPrismSDK/Apollo/Sources/Model/X25519Key.swift

@@ -23,6 +23,7 @@ struct X25519PrivateKey: PrivateKey {
 extension X25519PrivateKey: KeychainStorableKey {
  var restorationIdentifier: String { "x25519+priv" }
  var storableData: Data { raw }
+ var index: Int? { nil }
  var type: Domain.KeychainStorableKeyProperties.KeyAlgorithm { .rawKey }
  var keyClass: Domain.KeychainStorableKeyProperties.KeyType { .privateKey }
  var accessiblity: Domain.KeychainStorableKeyProperties.Accessability? { .firstUnlock(deviceOnly: true) }
@@ -50,6 +51,7 @@ struct X25519PublicKey: PublicKey {
 extension X25519PublicKey: KeychainStorableKey {
  var restorationIdentifier: String { "x25519+pub" }
  var storableData: Data { raw }
+ var index: Int? { nil }
  var type: Domain.KeychainStorableKeyProperties.KeyAlgorithm { .rawKey }
  var keyClass: Domain.KeychainStorableKeyProperties.KeyType { .publicKey }
  var accessiblity: Domain.KeychainStorableKeyProperties.Accessability? { .firstUnlock(deviceOnly: true) }

AtalaPrismSDK/Apollo/Sources/Operations/CreateLinkSecretOperation.swift

@@ -2,7 +2,7 @@ import AnoncredsSwift
 import Foundation
 
 struct CreateLinkSecretOperation {
- func create() -> String {
- Prover().createLinkSecret().getBigNumber()
+ func create() throws -> String {
+ try Prover().createLinkSecret().getValue()
  }
 }

AtalaPrismSDK/Apollo/Sources/Operations/CreateSec256k1KeyPairOperation.swift

@@ -16,6 +16,6 @@ struct CreateSec256k1KeyPairOperation {
  func compute() throws -> PrivateKey {
  let derivedKey = try HDKeychain(seed: seed.value).derivedKey(path: keyPath.keyPathString())
 
- return Secp256k1PrivateKey(lockedPrivateKey: derivedKey.privateKey())
+ return Secp256k1PrivateKey(lockedPrivateKey: derivedKey.privateKey(), derivationPath: keyPath)
  }
 }

AtalaPrismSDK/Apollo/Tests/ECSigningTests.swift

@@ -6,7 +6,10 @@ import XCTest
 final class ECSigningTests: XCTestCase {
  func testSigning() throws {
  let privKey = Secp256k1PrivateKey(
- lockedPrivateKey: .init(data: Data(fromBase64URL: "N_JFgvYaReyRXwassz5FHg33A4I6dczzdXrjdHGksmg")!)
+ lockedPrivateKey: .init(
+ data: Data(fromBase64URL: "N_JFgvYaReyRXwassz5FHg33A4I6dczzdXrjdHGksmg")!
+ ),
+ derivationPath: .init(index: 0)
  )
  let testMessage = "Test".data(using: .utf8)!
 

AtalaPrismSDK/Castor/Sources/Operations/CreatePeerDIDOperation.swift

@@ -150,8 +150,7 @@ struct CreatePeerDIDOperation {
  accept: endpoint.accept
  )
  }.compactMap { $0 }
- let encoder = JSONEncoder()
- encoder.outputFormatting = .withoutEscapingSlashes
+ let encoder = JSONEncoder.didComm()
  if
  peerDidServices.count == 1,
  let peerDidService = peerDidServices.first

AtalaPrismSDK/Castor/Tests/PeerDIDCreationTests.swift

@@ -5,7 +5,7 @@ import XCTest
 
 final class PeerDIDCreationTests: XCTestCase {
  func testPeerDIDCreation() throws {
- let validPeerDID = "did:peer:2.Ez6LSoHkfN1Y4nK9RCjx7vopWsLrMGNFNgTNZgoCNQrTzmb1n.Vz6MknRZmapV7uYZQuZez9n9N3tQotjRN18UGS68Vcfo6gR4h.SeyJyIjpbImRpZDpleGFtcGxlOnNvbWVtZWRpYXRvciNzb21la2V5Il0sInMiOiJodHRwczovL2V4YW1wbGUuY29tL2VuZHBvaW50IiwiYSI6W10sInQiOiJkbSJ9"
+ let validPeerDID = "did:peer:2.Ez6LSoHkfN1Y4nK9RCjx7vopWsLrMGNFNgTNZgoCNQrTzmb1n.Vz6MknRZmapV7uYZQuZez9n9N3tQotjRN18UGS68Vcfo6gR4h.SeyJhIjpbXSwiciI6WyJkaWQ6ZXhhbXBsZTpzb21lbWVkaWF0b3Ijc29tZWtleSJdLCJzIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS9lbmRwb2ludCIsInQiOiJkbSJ9"
  let apollo = ApolloImpl()
  let castor = CastorImpl(apollo: apollo)
  let keyAgreementPrivateKey = try apollo.createPrivateKey(parameters: [

AtalaPrismSDK/Domain/Sources/BBs/Apollo.swift

@@ -55,5 +55,5 @@ public protocol Apollo {
  /// - Returns: The decompressed public key
  func uncompressedPublicKey(compressedData: Data) -> PublicKey
 
- func createNewLinkSecret() -> String
+ func createNewLinkSecret() throws -> String
 }

AtalaPrismSDK/Domain/Sources/BBs/Pollux.swift

@@ -4,9 +4,9 @@ import Foundation
 /// Options that can be passed into various operations.
 public enum CredentialOperationsOptions {
  case schema(id: String, json: String) // The JSON schema.
- case schemasStream(stream: AnyPublisher<[(id: String, json: String)], Error>) // Stream of schemas, only the first batch is considered
+ case schemaDownloader(downloader: Downloader) // Stream of schemas, only the first batch is considered
  case credentialDefinition(id: String, json: String) // The JSON Credential Definition
- case credentialDefinitionsStream(stream: AnyPublisher<[(id: String, json: String)], Error>) // Stream of credential definitions, only the first batch is considered
+ case credentialDefinitionDownloader(downloader: Downloader) // Download of credential definitions, only the first batch is considered
  case linkSecret(id: String, secret: String) // A secret link.
  case subjectDID(DID) // The decentralized identifier of the subject.
  case entropy(String) // Entropy for any randomization operation.
@@ -21,7 +21,7 @@ public protocol Pollux {
  /// - Parameter data: The encoded item to parse.
  /// - Throws: An error if the item cannot be parsed or decoded.
  /// - Returns: An object representing the parsed item.
- func parseCredential(issuedCredential: Message) throws -> Credential
+ func parseCredential(issuedCredential: Message, options: [CredentialOperationsOptions]) async throws -> Credential
 
  /// Restores a previously stored item using the provided restoration identifier and data.
  /// - Parameters:

AtalaPrismSDK/Domain/Sources/Models/Common/Downloader.swift

@@ -0,0 +1,5 @@
+import Foundation
+
+public protocol Downloader {
+ func downloadFromEndpoint(urlOrDID: String) async throws -> Data
+}

AtalaPrismSDK/Domain/Sources/Models/Credentials/Credential.swift

@@ -70,6 +70,8 @@ public protocol Credential {
  var claims: [Claim] { get }
  /// Additional properties associated with the credential.
  var properties: [String: Any] { get }
+ /// The type of the credential Ex: JWT, Anoncred, W3C
+ var credentialType: String { get }
 }
 
 public extension Credential {

AtalaPrismSDK/Domain/Sources/Models/KeyManagement/ExportableImportableKey.swift

@@ -165,7 +165,7 @@ extension PEMKey {
  /// Returns a PEM-encoded string representation of this `PEMKey`.
  /// - Returns: A string representing this key in PEM format.
  public func pemEncoded() -> String {
- let base64Data = keyData.base64EncodedString(options: [.lineLength64Characters])
+ let base64Data = keyData.base64EncodedString()
  let beginMarker = "-----BEGIN \(keyType)-----"
  let endMarker = "-----END \(keyType)-----"
 

AtalaPrismSDK/Domain/Sources/Models/KeyManagement/KeyRestoration.swift

@@ -24,32 +24,13 @@ public protocol KeyRestoration {
  /// - data: The raw data representing the key.
  /// - Throws: If the restoration process fails, this method throws an error.
  /// - Returns: The restored `PrivateKey` instance.
- func restorePrivateKey(identifier: String?, data: Data) async throws -> PrivateKey
+ func restorePrivateKey(_ key: StorableKey) async throws -> PrivateKey
 
  /// Restores a public key from the given data.
  /// - Parameters:
  /// - identifier: An optional string used to identify the key.
  /// - data: The raw data representing the key.
  /// - Throws: If the restoration process fails, this method throws an error.
  /// - Returns: The restored `PublicKey` instance.
- func restorePublicKey(identifier: String?, data: Data) async throws -> PublicKey
-}
-
-/// Extension of the KeyRestoration protocol to provide additional restoration methods.
-public extension KeyRestoration {
- /// Restores a private key from the given data, without requiring an identifier.
- /// - Parameter data: The raw data representing the key.
- /// - Throws: If the restoration process fails, this method throws an error.
- /// - Returns: The restored PrivateKey instance.
- func restorePrivateKey(data: Data) async throws -> PrivateKey {
- try await restorePrivateKey(identifier: nil, data: data)
- }
-
- /// Restores a public key from the given data, without requiring an identifier.
- /// - Parameter data: The raw data representing the key.
- /// - Throws: If the restoration process fails, this method throws an error.
- /// - Returns: The restored `PublicKey` instance.
- func restorePublicKey(data: Data) async throws -> PublicKey {
- try await restorePublicKey(identifier: nil, data: data)
- }
+ func restorePublicKey(_ key: StorableKey) async throws -> PublicKey
 }

AtalaPrismSDK/Domain/Sources/Models/KeyManagement/StorableKey.swift

@@ -7,6 +7,9 @@ public protocol StorableKey {
 
  /// The raw data representation of the key, suitable for storage.
  var storableData: Data { get }
+
+ /// Indexation of the key is useful to keep track of a derivation index
+ var index: Int? { get }
 }
 
 /// Extension of the `Key` protocol to provide additional functionality related to storage.

AtalaPrismSDK/Pluto/Sources/Domain/Providers/DIDPrivateKeyProvider.swift

@@ -7,4 +7,5 @@ protocol DIDPrivateKeyProvider {
  func getDIDInfo(did: DID) -> AnyPublisher<(did: DID, privateKeys: [StorableKey], alias: String?)?, Error>
  func getDIDInfo(alias: String) -> AnyPublisher<[(did: DID, privateKeys: [StorableKey], alias: String?)], Error>
  func getPrivateKeys(did: DID) -> AnyPublisher<[StorableKey]?, Error>
+ func getLastKeyIndex() -> AnyPublisher<Int, Error>
 }

AtalaPrismSDK/Pluto/Sources/Domain/Providers/DIDProvider.swift

@@ -12,5 +12,4 @@ protocol DIDProvider {
  func getDIDInfo(
  keyPairIndex: Int
  ) -> AnyPublisher<(did: DID, keyPairIndex: Int, alias: String?)?, Error>
- func getLastKeyPairIndex() -> AnyPublisher<Int, Error>
 }

AtalaPrismSDK/Pluto/Sources/Domain/StorableKeyModel.swift

@@ -4,4 +4,5 @@ import Foundation
 struct StorableKeyModel: StorableKey {
  let restorationIdentifier: String
  let storableData: Data
+ let index: Int?
 }

AtalaPrismSDK/Pluto/Sources/PersistentStorage/DAO/CDDIDPrivateKeyDAO+DIDPrivateKeyProvider.swift

@@ -56,6 +56,17 @@ extension CDDIDPrivateKeyDAO: DIDPrivateKeyProvider {
  }
  .eraseToAnyPublisher()
  }
+
+ func getLastKeyIndex() -> AnyPublisher<Int, Error> {
+ keyDao.fetchController(
+ sorting: NSSortDescriptor(key: "index", ascending: true),
+ context: readContext
+ )
+ .map {
+ $0.first.map { $0.index?.intValue ?? 0 } ?? 0
+ }
+ .eraseToAnyPublisher()
+ }
 }
 
 extension CDKey {
@@ -79,12 +90,14 @@ extension CDKey {
 
  return StorableKeyModel(
  restorationIdentifier: keychainKey.restorationIdentifier,
- storableData: keyData
+ storableData: keyData,
+ index: keychainKey.index?.intValue
  )
  case let databaseKey as CDDatabaseKey:
  return StorableKeyModel(
  restorationIdentifier: databaseKey.restorationIdentifier,
- storableData: databaseKey.storableData
+ storableData: databaseKey.storableData,
+ index: databaseKey.index?.intValue
  )
  default:
  throw UnknownError.somethingWentWrongError(

AtalaPrismSDK/Pluto/Sources/PersistentStorage/DAO/CDDIDPrivateKeyDAO+DIDPrivateKeyStore.swift

@@ -91,6 +91,7 @@ private extension CDDatabaseKey {
  ) {
  self.identifier = identifier
  self.storableData = key.storableData
+ self.index = key.index.map { NSNumber(integerLiteral: $0) }
  self.restorationIdentifier = key.restorationIdentifier
  }
 }
@@ -104,6 +105,7 @@ private extension CDKeychainKey {
  ) {
  self.identifier = identifier
  self.restorationIdentifier = key.restorationIdentifier
+ self.index = key.index.map { NSNumber(integerLiteral: $0) }
  self.type = key.keyClass.rawValue
  self.algorithm = key.type.rawValue
  self.service = service

AtalaPrismSDK/Pluto/Sources/PersistentStorage/DAO/CDDIDPrivateKeyDAO.swift

@@ -6,6 +6,7 @@ struct CDDIDPrivateKeyDAO: CoreDataDAO {
  typealias CoreDataObject = CDDIDPrivateKey
  let keychain: KeychainStore & KeychainProvider
  let keychainService: String
+ let keyDao: CDKeyDAO
  let readContext: NSManagedObjectContext
  let writeContext: NSManagedObjectContext
  let identifierKey: String? = "did"

AtalaPrismSDK/Pluto/Sources/PersistentStorage/Keychain/KeychainDAO.swift

@@ -90,7 +90,7 @@ extension KeychainDAO: KeychainStore {
  try key.getSecKeyAddItemDictionary(service: service, account: account, accessGroup: accessGroup),
  nil
  )
- guard status == errSecSuccess else {
+ guard status == errSecSuccess || status == errSecDuplicateItem else {
  throw PlutoError.errorSavingKeyOnKeychainWithStatus(status)
  }
  }

AtalaPrismSDK/Pluto/Sources/PersistentStorage/Models/CDKey+CoreDataProperties.swift

@@ -8,6 +8,7 @@ extension CDKey {
 
  @NSManaged var identifier: String
  @NSManaged var restorationIdentifier: String
+ @NSManaged var index: NSNumber?
  @NSManaged var did: CDDIDPrivateKey?
 }
 

AtalaPrismSDK/Pluto/Sources/PlutoImpl+Public.swift

@@ -75,7 +75,7 @@ extension PlutoImpl: Pluto {
  }
 
  public func getPrismLastKeyPairIndex() -> AnyPublisher<Int, Error> {
- registeredDIDDao.getLastKeyPairIndex()
+ privateKeyDIDDao.getLastKeyIndex()
  }
 
  public func getAllPeerDIDs() -> AnyPublisher<[(did: DID, privateKeys: [StorableKey], alias: String?)], Error> {

AtalaPrismSDK/Pluto/Sources/PlutoImpl.swift

@@ -56,6 +56,10 @@ public struct PlutoImpl {
  let privateKeyDao = CDDIDPrivateKeyDAO(
  keychain: setup.keychain,
  keychainService: setup.keychainService,
+ keyDao: CDKeyDAO(
+ readContext: manager.mainContext,
+ writeContext: manager.editContext
+ ),
  readContext: manager.mainContext,
  writeContext: manager.editContext
  )