You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

134 lines
3.6 KiB

4 years ago
4 years ago
4 years ago
3 years ago
3 years ago
  1. // p≡p Basic API
  2. // Copyleft (c) 2019, p≡p foundation
  3. // this file is under GNU General Public License 3.0
  4. // see LICENSE.txt
  5. // written by Nana Karlstetter and Volker Birk
  6. type ISO639_1 is string size=2 > a-z
  7. type hex is string > a-f0-9
  8. type hash doc="32bit Key ID to SHA512 in hex"
  9. is hex min=16, max=128;
  10. type hash_list doc="sequence of fingerprints of keys"
  11. is list< hash >;
  12. type TID doc="UUID version 4 variant 1"
  13. is binary size=16;
  14. type blob_list is list< blob >;
  15. type identity_list is list< identity >;
  16. type string_list is list< string > ;
  17. type string_pair is pair< string, string >;
  18. enum comm_type {
  19. hex unknown 0;
  20. doc > range 0x01 to 0x09: no encryption, 0x0a to 0x0e: nothing reasonable
  21. hex no_encryption 0x01 doc="generic";
  22. hex no_encrypted_channel 0x02;
  23. hex key_not_found 0x03;
  24. hex key_expired 0x04;
  25. hex key_revoked 0x05;
  26. hex key_b0rken 0x06;
  27. hex key_expired_but_confirmed 0x07
  28. doc="NOT with confirmed bit. Just retaining info here in case of renewal.";
  29. hex my_key_not_included 0x09;
  30. hex security_by_obscurity 0x0a;
  31. hex b0rken_crypto 0x0b;
  32. hex key_too_short 0x0c;
  33. hex compromised 0x0e doc="known compromised connection";
  34. hex compromized 0x0e doc="deprecated misspelling";
  35. hex mistrusted 0x0f doc="known mistrusted key";
  36. doc > range 0x10 to 0x3f: unconfirmed encryption
  37. hex unconfirmed_encryption 0x10 doc="generic";
  38. hex OpenPGP_weak_unconfirmed 0x11 doc="RSA 1024 is weak";
  39. hex to_be_checked 0x20 doc="generic";
  40. hex SMIME_unconfirmed 0x21;
  41. hex CMS_unconfirmed 0x22;
  42. hex strong_but_unconfirmed 0x30 doc="generic";
  43. hex OpenPGP_unconfirmed 0x38 doc="key at least 2048 bit RSA or EC";
  44. hex OTR_unconfirmed 0x3a;
  45. doc > range 0x40 to 0x7f: unconfirmed encryption and anonymization
  46. hex unconfirmed_enc_anon 0x40 doc="generic";
  47. hex pEp_unconfirmed 0x7f
  48. hex confirmed 0x80 doc="this bit decides if trust is confirmed";
  49. doc > range 0x81 to 0x8f: reserved
  50. doc > range 0x90 to 0xbf: confirmed encryption
  51. hex confirmed_encryption 0x90 doc="generic";
  52. hex OpenPGP_weak 0x91 doc="RSA 1024 is weak (unused)";
  53. hex to_be_checked_confirmed 0xa0 doc="generic";
  54. hex SMIME 0xa1;
  55. hex CMS 0xa2;
  56. hex strong_encryption 0xb0 doc="generic";
  57. hex OpenPGP 0xb8 doc="key at least 2048 bit RSA or EC";
  58. hex OTR 0xba;
  59. doc > range 0xc0 to 0xff: confirmed encryption and anonymization
  60. hex confirmed_enc_anon 0xc0 doc="generic";
  61. hex pEp 0xff
  62. } // enum comm_type
  63. struct identity {
  64. field string address doc="SMTP address or URI";
  65. field hash fpr doc="fingerprint of key being used as ID";
  66. field string user_id doc="ID for person or entity in M2M case";
  67. field string username doc="descriptive string";
  68. field ISO639_1 lang doc="two-digit language code or null bytes";
  69. flags {
  70. flag not_for_sync 0x0001
  71. doc="don't use this identity for Sync";
  72. flag list 0x0002
  73. doc="identity of list of persons";
  74. doc | the second octet flags are calculated
  75. flag devicegroup 0x0100
  76. doc="identity of a device group member"
  77. }
  78. } // struct Identity
  79. callback messageToSend
  80. doc="a message needs to be delivered by application"
  81. {
  82. // parms
  83. provide struct_message msg doc="message struct with message to send"
  84. // exceptions
  85. throws any doc="error status"
  86. }