diff options
| author | Dominik Schürmann <dominik@dominikschuermann.de> | 2013-09-09 14:27:28 +0200 |
|---|---|---|
| committer | Dominik Schürmann <dominik@dominikschuermann.de> | 2013-09-09 14:27:28 +0200 |
| commit | 90cd8c32420970a0051ef518ab6c419033a2b3b3 (patch) | |
| tree | 1bfbd2d8cb6b771e48a417b8bf1eeb33f35a06b2 | |
| parent | 35b74f47d11d712896f52bdb672835e1bab20caf (diff) | |
| download | open-keychain-90cd8c32420970a0051ef518ab6c419033a2b3b3.tar.gz open-keychain-90cd8c32420970a0051ef518ab6c419033a2b3b3.tar.bz2 open-keychain-90cd8c32420970a0051ef518ab6c419033a2b3b3.zip | |
api docs
| -rw-r--r-- | API.md | 31 | ||||
| -rw-r--r-- | README.md | 28 |
2 files changed, 28 insertions, 31 deletions
diff --git a/API.md b/API.md deleted file mode 100644 index efe8e7f31..000000000 --- a/API.md +++ /dev/null @@ -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 @@ -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". |