Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krzyzanowskim/objectivepgp
ObjectivePGP is an open-source library for iOS and macOS that provides developers with tools for implementing OpenPGP encryption and decryption, digital signing, and signature verification in their applications, thereby enhancing security and data integrity.
https://github.com/krzyzanowskim/objectivepgp
encryption framework ios macos macos-swift objective-c openpgp osx pgp swift
Last synced: 15 days ago
JSON representation
ObjectivePGP is an open-source library for iOS and macOS that provides developers with tools for implementing OpenPGP encryption and decryption, digital signing, and signature verification in their applications, thereby enhancing security and data integrity.
- Host: GitHub
- URL: https://github.com/krzyzanowskim/objectivepgp
- Owner: krzyzanowskim
- License: other
- Created: 2014-07-25T14:21:11.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T16:32:53.000Z (8 months ago)
- Last Synced: 2024-04-14T05:45:51.675Z (7 months ago)
- Topics: encryption, framework, ios, macos, macos-swift, objective-c, openpgp, osx, pgp, swift
- Language: Objective-C
- Homepage: https://objectivepgp.com
- Size: 300 MB
- Stars: 655
- Watchers: 24
- Forks: 104
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE-third-party.txt
Awesome Lists containing this project
README
[](https://cocoapods.org/pods/ObjectivePGP)
[](https://github.com/apple/swift-package-manager)
[](#installation)
[](http://twitter.com/krzyzanowskim)
**ObjectivePGP** is an implementation of [OpenPGP](https://en.wikipedia.org/wiki/Pretty_Good_Privacy#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](https://blog.krzyzanowskim.com/2014/07/31/short-story-about-openpgp-for-ios-and-os-x-objectivepgp/) 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.
## Contribution
You are welcome to contribute. See [CONTRIBUTING.md](https://github.com/krzyzanowskim/ObjectivePGP/blob/master/CONTRIBUTING.md)
Please create [Pull Request](https://github.com/krzyzanowskim/ObjectivePGP/pulls).
## 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](./LICENSE.txt) 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](https://www.krzyzanowskim.com) for details.
Not sure what to choose? check [FAQ](https://github.com/krzyzanowskim/ObjectivePGP/wiki/FAQ)
## Installation
### Swift Package Manager
```
dependencies: [
.package(url: "https://github.com/krzyzanowskim/ObjectivePGP.git", .upToNextMinor(from: "0.99.4"))
]
```
### CocoaPods
````
pod 'ObjectivePGP'
````
### Frameworks
ObjectivePGP comes with the [Frameworks](./Frameworks) for the latest release, you can copy and embed in your project:
- [ObjectivePGP.framework](Frameworks/)
- [ObjectivePGP.xcframework](Frameworks/)
## Usage
Objective-C
```objective-c
#import
```
Swift
```swift
import ObjectivePGP
```
##### Read keys (private or public)
```objective-c
NSArray *keys = [ObjectivePGP readKeysFromPath:@"/path/to/key.asc" error:nil];
```
```swift
let keys = try ObjectivePGP.readKeys(fromPath: "/path/to/key.asc")
```
##### Keyring
Keyring is a storage (in memory or on disk) that keep all sorts of PGP keys.
```objective-c
PGPKeyring *keyring = ObjectivePGP.defaultKeyring;
PGPKeyring *keyring = [[PGPKeyring alloc] init];
NSArray *allKeys = keyring.keys;
[keyring importKeys:@[key]];
[keyring deleteKeys:@[key]];
[keyring importKey:@"979E4B03DFFE30C6" fromPath:@"/path/to/secring.gpg"];
PGPKey *key = [keyring findKeyWithIdentifier:@"979E4B03DFFE30C6"];
NSArray keys = [pgp findKeysForUserID:@"Name "];
```
```swift
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 ").forEach(key) {
// process key
}
```
##### Export keys (private or public)
```objective-c
// Write keyring to file
[[keyring export:error] writeToURL:[NSURL fileURLWithString:@"keyring.gpg"]];
// Public keys data
NSData *publicKeys = [keyring exportKeysOfType:PGPKeyTypePublic error:nil];
```
```swift
// 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:
```objective-c
NSData *signature = [ObjectivePGP sign:fileContent detached:YES usingKeys:@[key] passphraseForKey:nil error:nil];
[ObjectivePGP verify:fileContent withSignature:signature usingKeys:@[key] passphraseForKey:nil error:nil];
```
```swift
let signature = try ObjectivePGP.sign(encryptedBin, detached:true, using: [key1])
try ObjectivePGP.verify(encryptedBin, withSignature: signature, using: [key1])
```
##### Encrypt & Decrypt
```objective-c
NSData *encrypted = [ObjectivePGP encrypt:fileContent addSignature:YES usingKeys:@[key] passphraseForKey:nil error:nil];
[ObjectivePGP decrypt:encrypted andVerifySignature:YES usingKeys:@[key] passphraseForKey:nil error:nil];
```
```swift
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
```objective-c
PGPKeyGenerator *generator = [[PGPKeyGenerator alloc] init];
PGPKey *key = [generator generateFor:@"Marcin " passphrase:nil];
NSData *publicKeyData = [key export:PGPKeyTypePublic error:nil];
NSData *secretKeyData = [key export:PGPKeyTypeSecret error:nil];
```
```swift
let key = KeyGenerator().generate(for: "[email protected]", passphrase: "password")
let publicKey = try key.export(keyType: .public)
let secretKey = try key.export(keyType: .secret)
```
#### ASCII Armor
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.
Example:
```
-----BEGIN PGP PUBLIC KEY BLOCK-----
Comment: For more info see https://www.objectivepgp.org
[...]
-----END PGP PUBLIC KEY BLOCK-----
```
Class `PGPArmor` can be used to convert binary format to ASCII format
```objective-c
NSString *armoredKey = [PGPArmor armoredData:encrypted as:PGPArmorPublicKey];
```
```swift
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`
## Changelog
See [CHANGELOG](./CHANGELOG)
Known limitations:
- Cleartext signature.
## Security Audit
To date the ObjectivePGP code base has undergone a complete security audit from [Cure53](https://cure53.de/).
### Acknowledgment
This product uses software developed by the [OpenSSL](https://www.openssl.org/) Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)
### Author
[Marcin Krzyżanowski](https://krzyzanowskim.com)