Swiftpack.co - krzyzanowskim/ObjectivePGP as Swift Package

Swiftpack.co is a collection of thousands of indexed Swift packages. Search packages.
OpenPGP library for iOS and macOS
.package(url: "https://github.com/krzyzanowskim/ObjectivePGP.git", from: "privacy0.3.6#1")


CocoaPods Compatible Swift Package Manager compatible Platform Twitter

ObjectivePGP is an implementation of OpenPGP protocol for iOS and macOS. OpenPGP is the most widely used email encryption standard. It is defined by the OpenPGP Working Group of the Internet Engineering Task Force (IETF).

Here is the blog post story.

How do I get involved?

You want to help, great! Go ahead and fork our repo, make your changes and send us a pull request.


You are welcome to contribute. See CONTRIBUTING.md
Please create Pull Request.

The license

The ObjectivePGP stays under a dual license:

  • Free for non-commercial use, covered by the variant of BSD license. That means you have to mention Marcin Krzyżanowski as the original author of this code and reproduce the LICENSE text inside your app.

  • Commercial-use license to use in commercial products. Please bear in mind that some free products remain commercial products. Please contact me via email for details.

Not sure what to choose? check FAQ


Swift Package Manager

dependencies: [
    .package(url: "https://github.com/krzyzanowskim/ObjectivePGP.git", .upToNextMinor(from: "0.99.0"))


pod 'ObjectivePGP'


ObjectivePGP comes with the Frameworks for the latest release, you can copy and embed in your project:



#import <ObjectivePGP/ObjectivePGP.h>


import ObjectivePGP
Read keys (private or public)
NSArray<PGPKey *> *keys = [ObjectivePGP readKeysFromPath:@"/path/to/key.asc" error:nil];
let keys = try ObjectivePGP.readKeys(fromPath: "/path/to/key.asc")

Keyring is a storage (in memory or on disk) that keep all sorts of PGP keys.

PGPKeyring *keyring = ObjectivePGP.defaultKeyring;
PGPKeyring *keyring = [[PGPKeyring alloc] init];

NSArray<PGPKey *> *allKeys = keyring.keys;
[keyring importKeys:@[key]];
[keyring deleteKeys:@[key]];

[keyring importKey:@"979E4B03DFFE30C6" fromPath:@"/path/to/secring.gpg"];
PGPKey *key = [keyring findKeyWithIdentifier:@"979E4B03DFFE30C6"];
NSArray<PGPKey *> keys = [pgp findKeysForUserID:@"Name <email@example.com>"];
let keyring = ObjectivePGP.defaultKeyring
let keyring = Keyring()

let allKeys = keyring.keys
keyring.import(keys: [key])
keyring.delete(keys: [key])

keyring.import(keyIdentifier:"979E4B03DFFE30C6", fromPath:"/path/to/secring.gpg")
if let key = keyring.findKey("979E4B03DFFE30C6") {
	// key found in keyring

keyring.findKeys("Name <email@example.com>").forEach(key) {
	// process key
Export keys (private or public)
// Write keyring to file
[[keyring export:error] writeToURL:[NSURL fileURLWithString:@"keyring.gpg"]];

// Public keys data
NSData *publicKeys = [keyring exportKeysOfType:PGPKeyTypePublic error:nil];
// Write keyring to file
try keyring.export().write(to: URL(fileURLWithPath: "keyring.gpg"))

// Public keys (Data)
let publicKeys = keyring.exportKeys(of: .public)
Sign & verify data (or file)

Sign a data with a key:

NSData *signature = [ObjectivePGP sign:fileContent detached:YES usingKeys:@[key] passphraseForKey:nil error:nil];
[ObjectivePGP verify:fileContent withSignature:signature usingKeys:@[key] passphraseForKey:nil error:nil];
let signature = try ObjectivePGP.sign(encryptedBin, detached:true, using: [key1])
try ObjectivePGP.verify(encryptedBin, withSignature: signature, using: [key1])
Encrypt & Decrypt
NSData *encrypted = [ObjectivePGP encrypt:fileContent addSignature:YES usingKeys:@[key] passphraseForKey:nil error:nil];
[ObjectivePGP decrypt:encrypted andVerifySignature:YES usingKeys:@[key] passphraseForKey:nil error:nil];
let encrypted = try ObjectivePGP.encrypt(fileContent), addSignature: true, using: [key1, key2])
let decrypted = try ObjectivePGP.decrypt(encrypted, andVerifySignature: true, using: [key1])
Generate new key pair
PGPKeyGenerator *generator = [[PGPKeyGenerator alloc] init];
PGPKey *key = [generator generateFor:@"Marcin <marcin@example.com>" passphrase:nil];
NSData *publicKeyData = [key export:PGPKeyTypePublic error:nil];
NSData *secretKeyData = [key export:PGPKeyTypeSecret error:nil];
let key = KeyGenerator().generate(for: "marcin@example.com", passphrase: "password")
let publicKey = try key.export(keyType: .public)
let secretKey = try key.export(keyType: .secret)


ASCII armor is a binary-to-textual encoding converter. ASCII armor involves encasing encrypted messaging in ASCII so that they can be sent in a standard messaging format such as email.


Comment: For more info see http://www.objectivepgp.org


Class PGPArmor can be used to convert binary format to ASCII format

NSString *armoredKey = [PGPArmor armoredData:encrypted as:PGPArmorPublicKey];
let armoredKey = Armor.armored(Data(), as: .publicKey)

When convert manually, it is important to use right PGPArmorType value that define the header. It may be a tricky part so here's the cheatsheet:

Type data PGPArmorType Example
Encrypted PGPArmorMessage Armor.armored(ObjectivePGP.encrypt(...), as: .message)
Decrypted PGPArmorMessage Armor.armored(ObjectivePGP.decrypt(...), as: .message)
Public key PGPArmorTypePublic Armor.armored(key.export(), as: .publicKey)
Secret key PGPArmorTypeSecret Armor.armored(key.export(), as: .secretKey)

For any result of encryption the type is PGPArmorMessage



Known limitations:

  • Cleartext signature.

Security Audit

To date the ObjectivePGP code base has undergone a complete security audit from Cure53.


This product uses software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)


Marcin Krzyżanowski


Stars: 581
Last commit: 1 week ago

Ad: Job Offers

iOS Software Engineer @ Perry Street Software
Perry Street Software is Jack’d and SCRUFF. We are two of the world’s largest gay, bi, trans and queer social dating apps on iOS and Android. Our brands reach more than 20 million members worldwide so members can connect, meet and express themselves on a platform that prioritizes privacy and security. We invest heavily into SwiftUI and using Swift Packages to modularize the codebase.

Submit a free job ad (while I'm testing this). The analytics numbers for this website are here.

Release Notes

1 week ago
  • Elliptic-Curves support (RFC6637 https://datatracker.ietf.org/doc/html/rfc6637). #141
    • Elliptic-curve Diffie–Hellman.
    • Elliptic Curve Digital Signature Algorithm.
  • Enabling encrypt-only algorithms to encrypt. #187
  • Other fixes and improvements.

Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics