moparisthebest
/
open-keychain
mirror of https://github.com/moparisthebest/open-keychain
1
0
Fork 0
Code Issues Releases Wiki Activity

api docs

This commit is contained in:
Dominik Schürmann 2013-09-09 14:27:28 +02:00
parent 35b74f47d1
commit 90cd8c3242
2 changed files with 28 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
API.md
View File

@ -1,31 +0,0 @@
# Security Model
## Basic goals
* Intents invoked by apps that are not registered by Keychain's App API must require user interaction (e.g. click a button in a dialog to actually encrypt!)
## Without Permissions
### Intents
These Intents require user interaction!
All Intents start with ``org.sufficientlysecure.keychain.action.``
* ``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
* ``KEY_IMPORT`` with extra "keyring_bytes" or Uri in data with file schema
* ``KEY_IMPORT_FROM_QR_CODE`` without extras
* ``ENCRYPT`` TODO: explain extras (see source)
* ``ENCRYPT_FILE``
* ``DECRYPT`` TODO: explain extras (see source)
* ``DECRYPT_FILE``
TODO:
- new intent REGISTER_APP?
## App API

28
README.md
View File

@ -34,6 +34,34 @@ Android Studio is currently not supported or recommended!
2. File -> Import -> Android -> Existing Android Code Into Workspace, choose "OpenPGP-Keychain"
3. OpenPGP-Kechain can now be build
# Keychain API
## Basic goals
* Intents invoked by apps that are not registered by Keychain's App API must require user interaction (e.g. click a button in a dialog to actually encrypt!)
## API without registering the app
### Intents
These Intents require user interaction!
All Intents start with ``org.sufficientlysecure.keychain.action.``
* ``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
* ``KEY_IMPORT`` with extra "keyring_bytes" or Uri in data with file schema
* ``KEY_IMPORT_FROM_QR_CODE`` without extras
* ``ENCRYPT`` TODO: explain extras (see source)
* ``ENCRYPT_FILE``
* ``DECRYPT`` TODO: explain extras (see source)
* ``DECRYPT_FILE``
TODO:
- new intent REGISTER_APP?
## App API
TODO. See Demo App!
# Libraries
All JAR-Libraries are provided in this repository under "libs", all Android Library projects are under "libraries".