cthrace/open-keychain
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a7294d50b1f6a7f0ab30118602a1fcbdad0b8169
open-keychain/src/org/thialfihar/android/apg/IApgService.aidl

113 lines
4.6 KiB
Plaintext
Raw Normal View History

Add first basic implementation of Apgservice Provides an AIDL-API for other apps to encrypt and decrypt a string symmetrically with a passphrase. Function names and API is by no way finalized and will change! Support for asymetric encription will follow. For reference and discussion see issue #71, https://code.google.com/p/android-privacy-guard/issues/detail?id=71
2010-12-29 16:31:58 +00:00
package org.thialfihar.android.apg;
interface IApgService {
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
/* All functions fill the returnVals Bundle with the following keys:
Redesign AIDL-Interface once more Using Bundles makes passing data easier and does not need to redefine the interface if the internel functions change. The helper class has been updated accordingly. In addition, it wrappes completely around all input and output (if wanted).
2011-01-05 14:07:09 +00:00
*
* ArrayList<String> "WARNINGS" = Warnings, if any
Work on errors and documentation - once more
2011-01-20 20:00:28 +00:00
* ArrayList<String> "ERRORS" = Human readable error descriptions, if any
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
* int "ERROR" = Numeric representation of error, if any
* starting with 100:
Work on errors and documentation - once more
2011-01-20 20:00:28 +00:00
* 100: Required argument missing
* 101: Generic failure of APG
* 102: No matching private key found
* 103: Private key's passphrase wrong
* 104: Private key's passphrase missing
Redesign AIDL-Interface once more Using Bundles makes passing data easier and does not need to redefine the interface if the internel functions change. The helper class has been updated accordingly. In addition, it wrappes completely around all input and output (if wanted).
2011-01-05 14:07:09 +00:00
*/
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
/* ********************************************************
* Encryption
Allow to retrieve fingerprints and user ids through AIDL Update ApgCon and doc accordingly. Not very tested.
2011-01-23 21:36:35 +00:00
* ********************************************************/
/* All encryption function's arguments
Redesign AIDL-Interface once more Using Bundles makes passing data easier and does not need to redefine the interface if the internel functions change. The helper class has been updated accordingly. In addition, it wrappes completely around all input and output (if wanted).
2011-01-05 14:07:09 +00:00
*
Explain AIDL options a little bit more in detail
2011-01-09 20:12:03 +00:00
* Bundle params' keys:
Update AIDL to reflect new argument names In addition redesign the comments a little bit. Still doesn't look good, but at least a bit better.
2011-01-18 21:17:14 +00:00
* (optional/required)
* TYPE "STRING KEY" = EXPLANATION / VALUES
Redesign AIDL-Interface once more Using Bundles makes passing data easier and does not need to redefine the interface if the internel functions change. The helper class has been updated accordingly. In addition, it wrappes completely around all input and output (if wanted).
2011-01-05 14:07:09 +00:00
*
Update AIDL to reflect new argument names In addition redesign the comments a little bit. Still doesn't look good, but at least a bit better.
2011-01-18 21:17:14 +00:00
* (required)
* String "MESSAGE" = Message to encrypt
*
* (optional)
* int "ENCRYPTION_ALGORYTHM" = Encryption Algorithm
* 7: AES-128, 8: AES-192, 9: AES-256,
* 4: Blowfish, 10: Twofish, 3: CAST5,
* 6: DES, 2: Triple DES, 1: IDEA
* (optional)
* int "HASH_ALGORYTHM" = Hash Algorithm
* 1: MD5, 3: RIPEMD-160, 2: SHA-1,
* 11: SHA-224, 8: SHA-256, 9: SHA-384,
* 10: SHA-512
* (optional)
* Boolean "ARMORED_OUTPUT" = Armor output
*
* (optional)
* Boolean "FORCE_V3_SIGNATURE" = Force V3 Signatures
*
* (optional)
* int "COMPRESSION" = Compression to use
* 0x21070001: none, 1: Zip, 2: Zlib,
* 3: BZip2
* (optional)
* String "SIGNATURE_KEY" = Key to sign with
*
* (optional)
Fix wrong param in doc
2011-01-20 12:49:49 +00:00
* String "PRIVATE_KEY_PASSPHRASE" = Passphrase for signing key
Redesign AIDL-Interface once more Using Bundles makes passing data easier and does not need to redefine the interface if the internel functions change. The helper class has been updated accordingly. In addition, it wrappes completely around all input and output (if wanted).
2011-01-05 14:07:09 +00:00
*
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
* Bundle returnVals (in addition to the ERRORS/WARNINGS above):
Update AIDL to reflect new argument names In addition redesign the comments a little bit. Still doesn't look good, but at least a bit better.
2011-01-18 21:17:14 +00:00
* String "RESULT" = Encrypted message
Redesign AIDL-Interface once more Using Bundles makes passing data easier and does not need to redefine the interface if the internel functions change. The helper class has been updated accordingly. In addition, it wrappes completely around all input and output (if wanted).
2011-01-05 14:07:09 +00:00
*/
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
/* Additional argument for function below:
Update AIDL to reflect new argument names In addition redesign the comments a little bit. Still doesn't look good, but at least a bit better.
2011-01-18 21:17:14 +00:00
* (required)
* String "SYMMETRIC_PASSPHRASE" = Symmetric passphrase to use
Add asymmetric encryption
2011-01-13 20:12:10 +00:00
*/
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
boolean encryptWithPassphrase(in Bundle params, out Bundle returnVals);
Add asymmetric encryption
2011-01-13 20:12:10 +00:00
/* Additional argument:
Update AIDL to reflect new argument names In addition redesign the comments a little bit. Still doesn't look good, but at least a bit better.
2011-01-18 21:17:14 +00:00
* (required)
* ArrayList<String> "PUBLIC_KEYS" = Public keys (8char fingerprint "123ABC12" OR
* complete id "Alice Meyer <ab@email.com>")
Add asymmetric encryption
2011-01-13 20:12:10 +00:00
*/
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
boolean encryptWithPublicKey(in Bundle params, out Bundle returnVals);
Redesign AIDL-Interface once more Using Bundles makes passing data easier and does not need to redefine the interface if the internel functions change. The helper class has been updated accordingly. In addition, it wrappes completely around all input and output (if wanted).
2011-01-05 14:07:09 +00:00
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
/* ********************************************************
* Decryption
* ********************************************************/
/* Bundle params:
Update AIDL to reflect new argument names In addition redesign the comments a little bit. Still doesn't look good, but at least a bit better.
2011-01-18 21:17:14 +00:00
* (required)
* String "MESSAGE" = Message to decrypt
*
* (optional)
* String "SYMMETRIC_PASSPHRASE" = Symmetric passphrase for decryption
*
* (optional)
* String "PRIVATE_KEY_PASSPHRASE" = Private keys's passphrase on asymmetric encryption
Redesign AIDL-Interface once more Using Bundles makes passing data easier and does not need to redefine the interface if the internel functions change. The helper class has been updated accordingly. In addition, it wrappes completely around all input and output (if wanted).
2011-01-05 14:07:09 +00:00
*
* Bundle return_vals:
Update AIDL to reflect new argument names In addition redesign the comments a little bit. Still doesn't look good, but at least a bit better.
2011-01-18 21:17:14 +00:00
* String "RESULT" = Decrypted message
Redesign AIDL-Interface once more Using Bundles makes passing data easier and does not need to redefine the interface if the internel functions change. The helper class has been updated accordingly. In addition, it wrappes completely around all input and output (if wanted).
2011-01-05 14:07:09 +00:00
*/
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
boolean decrypt(in Bundle params, out Bundle returnVals);
/* ********************************************************
Allow to retrieve fingerprints and user ids through AIDL Update ApgCon and doc accordingly. Not very tested.
2011-01-23 21:36:35 +00:00
* Get key information
* ********************************************************/
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
Allow to retrieve fingerprints and user ids through AIDL Update ApgCon and doc accordingly. Not very tested.
2011-01-23 21:36:35 +00:00
/* Get info about all available keys
*
* Bundle params:
* (required)
* int "KEY_TYPE" = info about what type of keys to return
* 0: public keys
* 1: private keys
*
* Returns:
* StringArrayList "FINGERPRINTS" = Short fingerprints of keys
*
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
* StringArrayList "USER_IDS" = User ids of corresponding fingerprints
* (order is the same as in FINGERPRINTS)
Allow to retrieve fingerprints and user ids through AIDL Update ApgCon and doc accordingly. Not very tested.
2011-01-23 21:36:35 +00:00
*/
Cleanup of code, AIDL-calls renamed!
2011-06-05 19:05:57 +00:00
boolean getKeys(in Bundle params, out Bundle returnVals);
Allow to retrieve fingerprints and user ids through AIDL Update ApgCon and doc accordingly. Not very tested.
2011-01-23 21:36:35 +00:00
Add first basic implementation of Apgservice Provides an AIDL-API for other apps to encrypt and decrypt a string symmetrically with a passphrase. Function names and API is by no way finalized and will change! Support for asymetric encription will follow. For reference and discussion see issue #71, https://code.google.com/p/android-privacy-guard/issues/detail?id=71
2010-12-29 16:31:58 +00:00
}
Reference in New Issue Copy Permalink