mirror of
https://github.com/moparisthebest/open-keychain
synced 2024-11-27 11:12:15 -05:00
Update AIDL-Doc
This commit is contained in:
parent
f9ee141ce1
commit
dc02a74d52
@ -2,39 +2,41 @@ package org.thialfihar.android.apg;
|
||||
|
||||
interface IApgService {
|
||||
|
||||
/** All functions fill the return_vals Bundle with the following keys:
|
||||
/* All functions fill the return_vals Bundle with the following keys:
|
||||
*
|
||||
* ArrayList<String> "WARNINGS" = Warnings, if any
|
||||
* ArrayList<String> "ERRORS" = Human readable error descriptions, why function call failed
|
||||
* int "ERROR" = Numeric representation of error
|
||||
*/
|
||||
|
||||
/** Encryption function's arguments
|
||||
/* Encryption function's arguments
|
||||
*
|
||||
* Bundle params' keys:
|
||||
* (optional/required) TYPE "STRING KEY" = EXPLANATION / VALUES
|
||||
* (optional/required) TYPE "STRING KEY" = EXPLANATION / VALUES
|
||||
*
|
||||
* (required) String "MSG" = Message to encrypt
|
||||
* (optional) int "ENCRYPTION_ALGO" = 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_ALGO" = 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" = Armor output
|
||||
* (optional) Boolean "FORCE_V3_SIG" = Force V3 Signatures
|
||||
* (optional) int "COMPRESSION" = Compression to use
|
||||
0x21070001: none, 1: Zip, 2: Zlib,
|
||||
3: BZip2
|
||||
* (required) String "MSG" = Message to encrypt
|
||||
* (optional) int "ENCRYPTION_ALGO" = 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_ALGO" = 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" = Armor output
|
||||
* (optional) Boolean "FORCE_V3_SIG" = 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) String "SIGNATURE_KEY_PASS" = Passphrase for signing key
|
||||
*
|
||||
* Bundle return_vals (in addition to the ERRORS/WARNINGS above):
|
||||
* String "RESULT" = Encrypted MSG
|
||||
* String "RESULT" = Encrypted MSG
|
||||
*/
|
||||
|
||||
/* Additional argument:
|
||||
* (required) String "SYM_KEY" = Symmetric key to use
|
||||
* (required) String "SYM_KEY" = Symmetric key to use
|
||||
*/
|
||||
boolean encrypt_with_passphrase(in Bundle params, out Bundle return_vals);
|
||||
|
||||
@ -45,14 +47,15 @@ interface IApgService {
|
||||
boolean encrypt_with_public_key(in Bundle params, out Bundle return_vals);
|
||||
|
||||
|
||||
/** Decrypt something
|
||||
/* Decrypt something
|
||||
*
|
||||
* Bundle params:
|
||||
* (required) String "MSG" = Message to decrypt
|
||||
* (optional) String "SYM_KEY" = Symmetric key to use if encryption is symmetric
|
||||
* (required) String "MSG" = Message to decrypt
|
||||
* (optional) String "SYM_KEY" = Symmetric key to use if encryption is symmetric
|
||||
* (optional) String "PRIVATE_KEY_PASS" = Private keys's passphrase on asymmetric encryption
|
||||
*
|
||||
* Bundle return_vals:
|
||||
* String "RESULT" = Decrypted MSG
|
||||
* String "RESULT" = Decrypted MSG
|
||||
*/
|
||||
boolean decrypt(in Bundle params, out Bundle return_vals);
|
||||
}
|
Loading…
Reference in New Issue
Block a user