mirror of
https://github.com/moparisthebest/open-keychain
synced 2024-11-27 11:12:15 -05:00
rename in README
This commit is contained in:
parent
e75fd5a156
commit
77c635ea12
@ -50,7 +50,6 @@ import org.spongycastle.openpgp.operator.jcajce.JcePBEDataDecryptorFactoryBuilde
|
|||||||
import org.spongycastle.openpgp.operator.jcajce.JcePBESecretKeyDecryptorBuilder;
|
import org.spongycastle.openpgp.operator.jcajce.JcePBESecretKeyDecryptorBuilder;
|
||||||
import org.spongycastle.openpgp.operator.jcajce.JcePublicKeyDataDecryptorFactoryBuilder;
|
import org.spongycastle.openpgp.operator.jcajce.JcePublicKeyDataDecryptorFactoryBuilder;
|
||||||
import org.sufficientlysecure.keychain.Constants;
|
import org.sufficientlysecure.keychain.Constants;
|
||||||
import org.sufficientlysecure.keychain.Id;
|
|
||||||
import org.sufficientlysecure.keychain.R;
|
import org.sufficientlysecure.keychain.R;
|
||||||
import org.sufficientlysecure.keychain.pgp.exception.PgpGeneralException;
|
import org.sufficientlysecure.keychain.pgp.exception.PgpGeneralException;
|
||||||
import org.sufficientlysecure.keychain.provider.ProviderHelper;
|
import org.sufficientlysecure.keychain.provider.ProviderHelper;
|
||||||
|
23
README.md
23
README.md
@ -1,6 +1,6 @@
|
|||||||
# OpenPGP Keychain (for Android)
|
# OpenKeychain (for Android)
|
||||||
|
|
||||||
OpenPGP Keychain is an OpenPGP implementation for Android.
|
OpenKeychain is an OpenPGP implementation for Android.
|
||||||
The development began as a fork of Android Privacy Guard (APG).
|
The development began as a fork of Android Privacy Guard (APG).
|
||||||
|
|
||||||
see http://sufficientlysecure.org/keychain
|
see http://sufficientlysecure.org/keychain
|
||||||
@ -17,10 +17,10 @@ Translations are managed at Transifex, please contribute there at https://www.tr
|
|||||||
2. Lookout for interesting issues on our issue page at Github: https://github.com/openpgp-keychain/openpgp-keychain/issues
|
2. Lookout for interesting issues on our issue page at Github: https://github.com/openpgp-keychain/openpgp-keychain/issues
|
||||||
3. Tell us about your plans on the mailinglist
|
3. Tell us about your plans on the mailinglist
|
||||||
4. Read this README, especially the notes about coding style
|
4. Read this README, especially the notes about coding style
|
||||||
5. Fork OpenPGP Keychain and contribute code (the best part ;) )
|
5. Fork OpenKeychain and contribute code (the best part ;) )
|
||||||
6. Open a pull request on Github. I will help with occuring problems and merge your changes back into the main project.
|
6. Open a pull request on Github. I will help with occuring problems and merge your changes back into the main project.
|
||||||
|
|
||||||
I am happy about every code contribution and appreciate your effort to help us developing OpenPGP Keychain!
|
I am happy about every code contribution and appreciate your effort to help us developing OpenKeychain!
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
@ -64,7 +64,7 @@ To do automatic encryption/decryption/sign/verify use the OpenPGP Remote API.
|
|||||||
* ``android.intent.action.VIEW`` connected to .gpg and .asc files: Import Key and Decrypt
|
* ``android.intent.action.VIEW`` connected to .gpg and .asc files: Import Key and Decrypt
|
||||||
* ``android.intent.action.SEND`` connected to all mime types (text/plain and every binary data like files and images): Encrypt and Decrypt
|
* ``android.intent.action.SEND`` connected to all mime types (text/plain and every binary data like files and images): Encrypt and Decrypt
|
||||||
|
|
||||||
#### OpenPGP Keychain Intent actions:
|
#### OpenKeychain Intent actions:
|
||||||
|
|
||||||
* ``org.sufficientlysecure.keychain.action.ENCRYPT``
|
* ``org.sufficientlysecure.keychain.action.ENCRYPT``
|
||||||
* To encrypt or sign text, use extra ``text`` (type: ``String``)
|
* To encrypt or sign text, use extra ``text`` (type: ``String``)
|
||||||
@ -82,7 +82,7 @@ To do automatic encryption/decryption/sign/verify use the OpenPGP Remote API.
|
|||||||
* ``org.sufficientlysecure.keychain.action.IMPORT_KEY_FROM_QR_CODE``
|
* ``org.sufficientlysecure.keychain.action.IMPORT_KEY_FROM_QR_CODE``
|
||||||
* without extras, starts Barcode Scanner to get QR Code
|
* without extras, starts Barcode Scanner to get QR Code
|
||||||
|
|
||||||
#### OpenPGP Keychain special registered Intents:
|
#### OpenKeychain special registered Intents:
|
||||||
* ``android.intent.action.VIEW`` with URIs following the ``openpgp4fpr`` schema. For example: ``openpgp4fpr:73EE2314F65FA92EC2390D3A718C070100012282``. This is used in QR Codes, but could also be embedded into your website. (compatible with Monkeysphere's and Guardian Project's QR Codes)
|
* ``android.intent.action.VIEW`` with URIs following the ``openpgp4fpr`` schema. For example: ``openpgp4fpr:73EE2314F65FA92EC2390D3A718C070100012282``. This is used in QR Codes, but could also be embedded into your website. (compatible with Monkeysphere's and Guardian Project's QR Codes)
|
||||||
* NFC (``android.nfc.action.NDEF_DISCOVERED``) on mime type ``application/pgp-keys`` (as specified in http://tools.ietf.org/html/rfc3156, section 7)
|
* NFC (``android.nfc.action.NDEF_DISCOVERED``) on mime type ``application/pgp-keys`` (as specified in http://tools.ietf.org/html/rfc3156, section 7)
|
||||||
|
|
||||||
@ -103,10 +103,10 @@ The service definition defines sign, encrypt, signAndEncrypt, decryptAndVerify,
|
|||||||
|
|
||||||
As can be seen in the API Demo, the apps themselves never need to handle key ids directly.
|
As can be seen in the API Demo, the apps themselves never need to handle key ids directly.
|
||||||
You can use user ids (emails) to define recipients.
|
You can use user ids (emails) to define recipients.
|
||||||
If more than one public key exists for an email, OpenPGP Keychain will handle the problem by showing a selection screen. Additionally, it is also possible to use key ids.
|
If more than one public key exists for an email, OpenKeychain will handle the problem by showing a selection screen. Additionally, it is also possible to use key ids.
|
||||||
|
|
||||||
Also app devs never need to fiddle with private keys.
|
Also app devs never need to fiddle with private keys.
|
||||||
On first operation, OpenPGP Keychain shows an activity to allow or disallow access, while also allowing to choose the private key used for this app.
|
On first operation, OpenKeychain shows an activity to allow or disallow access, while also allowing to choose the private key used for this app.
|
||||||
Please try the Demo app out to see how it works.
|
Please try the Demo app out to see how it works.
|
||||||
|
|
||||||
#### Integration
|
#### Integration
|
||||||
@ -134,7 +134,7 @@ Only classes related to QR Code generation are utilized.
|
|||||||
|
|
||||||
#### Spongy Castle
|
#### Spongy Castle
|
||||||
|
|
||||||
Spongy Castle is the stock Bouncy Castle libraries with a couple of small changes to make it work on Android. OpenPGP Keychain uses a forked version with some small changes. These changes will been sent to Bouncy Castle, and Spongy Castle will be used again when they have filtered down.
|
Spongy Castle is the stock Bouncy Castle libraries with a couple of small changes to make it work on Android. OpenKeychain uses a forked version with some small changes. These changes will been sent to Bouncy Castle, and Spongy Castle will be used again when they have filtered down.
|
||||||
|
|
||||||
see
|
see
|
||||||
* Fork: https://github.com/openpgp-keychain/spongycastle
|
* Fork: https://github.com/openpgp-keychain/spongycastle
|
||||||
@ -156,11 +156,10 @@ see
|
|||||||
|
|
||||||
### Gradle Build System
|
### Gradle Build System
|
||||||
|
|
||||||
We try to make our builds as [reproducible/deterministic](https://blog.torproject.org/blog/deterministic-builds-part-one-cyberwar-and-global-compromise) as possible.
|
We try to make our builds as [reproducible/deterministic](https://blog.torproject.org/blog/deterministic-builds-part-one-cyberwar-and-global-compromise) as possible.
|
||||||
This is also a key requirement to be part of F-Droid.
|
|
||||||
When changing build files or dependencies, respect the following requirements:
|
When changing build files or dependencies, respect the following requirements:
|
||||||
- No precompiled libraries. All libraries should be provided as sourcecode in "libraries" folder
|
- No precompiled libraries. All libraries should be provided as sourcecode in "libraries" folder
|
||||||
- No dependencies from Maven
|
- No dependencies from Maven (also a soft requirement for inclusion in F-Droid)
|
||||||
- Always use a fixed Android Gradle plugin version not a dynamic one, e.g. ``0.7.3`` instead of ``0.7.+``
|
- Always use a fixed Android Gradle plugin version not a dynamic one, e.g. ``0.7.3`` instead of ``0.7.+``
|
||||||
- Commit the corresponding gradle wrapper version to the repository
|
- Commit the corresponding gradle wrapper version to the repository
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user