moparisthebest/open-keychain
1
0
Fork 0
mirror of https://github.com/moparisthebest/open-keychain synced 2025-02-25 07:51:48 -05:00
Code Issues Releases Wiki Activity

API docs

Browse Source
This commit is contained in:
Dominik Schürmann 2013-09-10 00:17:18 +02:00
parent db3feaca6e
commit b5c865f5a6
2 changed files with 24 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
OpenPGP-Keychain/src/org/sufficientlysecure/keychain/ui/DecryptActivity.java
View File

@ -81,7 +81,6 @@ public class DecryptActivity extends SherlockFragmentActivity {
public static final String EXTRA_DATA = "data"; public static final String EXTRA_DATA = "data";
public static final String EXTRA_REPLY_TO = "reply_to"; public static final String EXTRA_REPLY_TO = "reply_to";
public static final String EXTRA_SUBJECT = "subject"; public static final String EXTRA_SUBJECT = "subject";
public static final String EXTRA_BINARY = "binary";
private long mSignatureKeyId = 0; private long mSignatureKeyId = 0;

39
README.md
View File

@ -45,30 +45,39 @@ Android Studio is currently not supported or recommended!
## API without registering the app ## API without registering the app
### Intent Actions ### Intent Actions
These Intents require user interaction! All Intents require user interaction, e.g. encryption is not done automatically. The user needs to press the Encrypt button.
To do automatic encryption/decryption/sign/verify use the Remote Serive API.
Android Intent actions provided by OpenPGP Keychain:
* ``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
All Intents start with ``org.sufficientlysecure.keychain.action.`` OpenPGP Keychain specific Intent actions:
* ``ENCRYPT`` * ``org.sufficientlysecure.keychain.action.ENCRYPT``
* TODO: explain extras (see source) * To encrypt text use extra ``text`` (type: ``String``)
* ``ENCRYPT_FILE`` * To encrypt bytes use extra ``data`` (type: ``byte[]``)
* ``DECRYPT`` * Enable ASCII Armor (encoding to Radix-64, 33% overhead) by adding the extra ``ascii_armor`` with value ``true``
* TODO: explain extras (see source) * ``org.sufficientlysecure.keychain.action.ENCRYPT_FILE``
* ``DECRYPT_FILE`` * Include data ``Uri`` (``intent.setData()``) pointing to a file or content provider
* ``IMPORT_KEY`` * ``org.sufficientlysecure.keychain.action.DECRYPT``
* To decrypt text use extra ``text`` (type: ``String``)
* To decrypt bytes use extra ``data`` (type: ``byte[]``)* ``org.sufficientlysecure.keychain.action.DECRYPT_FILE``
* Include data ``Uri`` (``intent.setData()``) pointing to a file or content provider
* ``org.sufficientlysecure.keychain.action.IMPORT_KEY``
* Extras: ``keyring_bytes`` (type: ``byte[]``) * Extras: ``keyring_bytes`` (type: ``byte[]``)
* or Uri in data with file schema * or Uri in data with file schema
* ``IMPORT_KEY_FROM_QR_CODE`` * ``org.sufficientlysecure.keychain.action.IMPORT_KEY_FROM_QR_CODE``
* without extras * without extras starts Barcode Scanner to get QR Code
TODO: ## Remote Serive API
- new intent REGISTER_APP? To do asyncronous fast encryption/decryption/sign/verify operations bind to the remote service.
The API Demo contains all required AIDL files and a demo activity.
## App API ### Tutorial
TODO. See Demo App! 1. Include all files from https://github.com/dschuermann/openpgp-keychain/tree/master/OpenPGP-Keychain-API-Demo/src/org/openintents/crypto
2. An example how to query for all available crypto providers: https://github.com/dschuermann/openpgp-keychain/blob/master/OpenPGP-Keychain-API-Demo/src/org/sufficientlysecure/keychain/demo/CryptoProviderDemoActivity.java
# Libraries # Libraries