pEpObjCAdapterFramework/PEPEngineTypes.h
author Dirk Zimmermann <dz@pep.security>
Fri, 01 Mar 2019 16:03:28 +0100
branchIOS-1480
changeset 847 699c535ce67b
parent 846 1871d4dcd3fd
child 852 70ff0529c54d
permissions -rw-r--r--
IOS-1480 PEPTypes.h for adapter types.
     1 //
     2 //  PEPTypes.h
     3 //  pEpObjCAdapter
     4 //
     5 //  Created by Dirk Zimmermann on 27.02.19.
     6 //  Copyright © 2019 p≡p. All rights reserved.
     7 //
     8 
     9 #ifndef PEPTypes_h
    10 #define PEPTypes_h
    11 
    12 #import <Foundation/Foundation.h>
    13 
    14 typedef enum _ObjC_PEP_decrypt_flags {
    15     PEPDecryptFlagOwnPrivateKey = 0x1, // PEP_decrypt_flag_own_private_key = 0x1,
    16     PEPDecryptFlagConsume = 0x2, // PEP_decrypt_flag_consume = 0x2,
    17     PEPDecryptFlagIgnore = 0x4, // PEP_decrypt_flag_ignore = 0x4,
    18     PEPDecryptFlagSrcModified = 0x8, // PEP_decrypt_flag_src_modified = 0x8,
    19     // input flags
    20     PEPDecryptFlagUntrustedServer = 0x100 // PEP_decrypt_flag_untrusted_server = 0x100
    21 } PEPDecryptFlags; // PEP_decrypt_flags;
    22 
    23 typedef enum _ObjC_PEP_enc_format {
    24     PEPEncNone = 0, // PEP_enc_none = 0, // message is not encrypted
    25     PEPEncPieces, // PEP_enc_pieces, // inline PGP + PGP extensions
    26     PEPEncSMIME, // PEP_enc_S_MIME, // RFC5751
    27     PEPEncPGPMIME, // PEP_enc_PGP_MIME, // RFC3156
    28     PEPEncPEP, // PEP_enc_PEP, // pEp encryption format
    29     PEPEncPGPMIMEOutlook1 // PEP_enc_PGP_MIME_Outlook1 // Message B0rken by Outlook type 1
    30 } PEPEncFormat;
    31 
    32 typedef enum _ObjC_PEP_rating {
    33     PEPRatingUndefined = 0,// PEP_rating_undefined = 0,
    34     PEPRatingCannotDecrypt, // PEP_rating_cannot_decrypt,
    35     PEPRatingHaveNoKey, // PEP_rating_have_no_key,
    36     PEPRatingUnencrypted, // PEP_rating_unencrypted,
    37     PEPRatingUnencryptedForSome, // PEP_rating_unencrypted_for_some, // don't use this any more
    38     PEPRatingUnreliable, // PEP_rating_unreliable,
    39     PEPRatingReliable, // PEP_rating_reliable,
    40     PEPRatingTrusted, // PEP_rating_trusted,
    41     PEPRatingTrustedAndAnonymized, // PEP_rating_trusted_and_anonymized,
    42     PEPRatingFullyAnonymous, // PEP_rating_fully_anonymous,
    43 
    44     PEPRatingMistrust = -1, // PEP_rating_mistrust = -1,
    45     PEPRatingB0rken = -2, // PEP_rating_b0rken = -2,
    46     PEPRatingUnderAttack = -3 // PEP_rating_under_attack = -3
    47 } PEPRating;
    48 
    49 typedef enum {
    50     PEPStatusOK                                   = 0, // PEP_STATUS_OK
    51 
    52     PEPInitCannotLoadGPME                      = 0x0110, // PEP_INIT_CANNOT_LOAD_GPGME
    53     PEPInitGPGMEInitFailed                      = 0x0111, // PEP_INIT_GPGME_INIT_FAILED
    54     PEPInitNoGPGHome                            = 0x0112, // PEP_INIT_NO_GPG_HOME
    55     PEPInitNETPGPInitFailed                     = 0x0113, // PEP_INIT_NETPGP_INIT_FAILED
    56     PEPInitCannotDetermineGPGVersion           = 0x0114, // PEP_INIT_CANNOT_DETERMINE_GPG_VERSION
    57     PEPInitUnsupportedGPGVersion                = 0x0115, // PEP_INIT_UNSUPPORTED_GPG_VERSION
    58     PEPInitCannotConfigGPGAgent                = 0x0116, // PEP_INIT_CANNOT_CONFIG_GPG_AGENT
    59 
    60     PEPInitSqlite3WithoutMutex                  = 0x0120, // PEP_INIT_SQLITE3_WITHOUT_MUTEX
    61     PEPInitCannotOpenDB                         = 0x0121, // PEP_INIT_CANNOT_OPEN_DB
    62     PEPInitCannotOpenSystemDB                  = 0x0122, // PEP_INIT_CANNOT_OPEN_SYSTEM_DB
    63     PEPUnknownDBError                            = 0x01ff, // PEP_UNKNOWN_DB_ERROR
    64 
    65     PEPKeyNotFound                               = 0x0201, // PEP_KEY_NOT_FOUND
    66     PEPKeyHasAmbigName                          = 0x0202, // PEP_KEY_HAS_AMBIG_NAME
    67     PEPGetKeyFailed                              = 0x0203, // PEP_GET_KEY_FAILED
    68     PEPCannotExportKey                           = 0x0204, // PEP_CANNOT_EXPORT_KEY
    69     PEPCannotEditKey                             = 0x0205, // PEP_CANNOT_EDIT_KEY
    70     PEPKeyUnsuitable                              = 0x0206, // PEP_KEY_UNSUITABLE
    71     PEPMalformedKeyResetMsg                     = 0x0210, // PEP_MALFORMED_KEY_RESET_MSG
    72     PEPKeyNotReset                               = 0x0211, // PEP_KEY_NOT_RESET
    73 
    74     PEPKeyImported                                = 0x0220, // PEP_KEY_IMPORTED
    75     PEPNoKeyImported                             = 0x0221, // PEP_NO_KEY_IMPORTED
    76     PEPKeyImportStatusUnknown                   = 0x0222, // PEP_KEY_IMPORT_STATUS_UNKNOWN
    77 
    78     PEPCannotFindIdentity                        = 0x0301, // PEP_CANNOT_FIND_IDENTITY
    79     PEPCannotSetPerson                           = 0x0381, // PEP_CANNOT_SET_PERSON
    80     PEPCannotSetPGPKeyPair                      = 0x0382, // PEP_CANNOT_SET_PGP_KEYPAIR
    81     PEPCannotSetIdentity                         = 0x0383, // PEP_CANNOT_SET_IDENTITY
    82     PEPCannotSetTrust                            = 0x0384, // PEP_CANNOT_SET_TRUST
    83     PEPKeyBlacklisted                             = 0x0385, // PEP_KEY_BLACKLISTED
    84     PEPCannotFindPerson                          = 0x0386, // PEP_CANNOT_FIND_PERSON
    85 
    86     PEPCannotFindAlias                           = 0x0391, // PEP_CANNOT_FIND_ALIAS
    87     PEPCannotSetAlias                            = 0x0392, // PEP_CANNOT_SET_ALIAS
    88 
    89     PEPUnencrypted                                 = 0x0400, // PEP_UNENCRYPTED
    90     PEPVerified                                    = 0x0401, // PEP_VERIFIED
    91     PEPDecrypted                                   = 0x0402, // PEP_DECRYPTED
    92     PEPDecryptedAndVerified                      = 0x0403, // PEP_DECRYPTED_AND_VERIFIED
    93     PEPDecryptWrongFormat                        = 0x0404, // PEP_DECRYPT_WRONG_FORMAT
    94     PEPDecryptNoKey                              = 0x0405, // PEP_DECRYPT_NO_KEY
    95     PEPDecryptSignatureDoesNotMatch            = 0x0406, // PEP_DECRYPT_SIGNATURE_DOES_NOT_MATCH
    96     PEPVerifyNoKey                               = 0x0407, // PEP_VERIFY_NO_KEY
    97     PEPVerifiedAndTrusted                        = 0x0408, // PEP_VERIFIED_AND_TRUSTED
    98     PEPCannotReencrypt                            = 0x0409, // PEP_CANNOT_REENCRYPT
    99     PEPCannotDecryptUnknown                      = 0x04ff, // PEP_CANNOT_DECRYPT_UNKNOWN
   100 
   101     PEPTrustwordNotFound                         = 0x0501, // PEP_TRUSTWORD_NOT_FOUND
   102     PEPTrustwordsFPRWrongLength                 = 0x0502, // PEP_TRUSTWORDS_FPR_WRONG_LENGTH
   103     PEPTrustwordsDuplicateFPR                    = 0x0503, // PEP_TRUSTWORDS_DUPLICATE_FPR
   104 
   105     PEPCannotCreateKey                           = 0x0601, // PEP_CANNOT_CREATE_KEY
   106     PEPCannotSendKey                             = 0x0602, // PEP_CANNOT_SEND_KEY
   107 
   108     PEPPhraseNotFound                            = 0x0701, // PEP_PHRASE_NOT_FOUND
   109 
   110     PEPSendFunctionNotRegistered                = 0x0801, // PEP_SEND_FUNCTION_NOT_REGISTERED
   111     PEPConstraintsViolated                         = 0x0802, // PEP_CONTRAINTS_VIOLATED
   112     PEPCannotEncode                               = 0x0803, // PEP_CANNOT_ENCODE
   113 
   114     PEPSyncNoNotifyCallback                     = 0x0901, // PEP_SYNC_NO_NOTIFY_CALLBACK
   115     PEPSyncIllegalMessage                        = 0x0902, // PEP_SYNC_ILLEGAL_MESSAGE
   116     PEPSyncNoInjectCallback                     = 0x0903, // PEP_SYNC_NO_INJECT_CALLBACK
   117     PEPSyncNoChannel                             = 0x0904, // PEP_SYNC_NO_CHANNEL
   118     PEPSyncCannotEncrypt                         = 0x0905, // PEP_SYNC_CANNOT_ENCRYPT
   119     PEPSyncNoMessageSendCallback               = 0x0906, // PEP_SYNC_NO_MESSAGE_SEND_CALLBACK
   120 
   121     PEPCannotIncreaseSequence                    = 0x0971, // PEP_CANNOT_INCREASE_SEQUENCE
   122 
   123     PEPStatemachineError                          = 0x0980, // PEP_STATEMACHINE_ERROR
   124     PEPNoTrust                                    = 0x0981, // PEP_NO_TRUST
   125     PEPStatemachineInvalidState                  = 0x0982, // PEP_STATEMACHINE_INVALID_STATE
   126     PEPStatemachineInvalidEvent                  = 0x0983, // PEP_STATEMACHINE_INVALID_EVENT
   127     PEPStatemachineInvalidCondition              = 0x0984, // PEP_STATEMACHINE_INVALID_CONDITION
   128     PEPStatemachineInvalidAction                 = 0x0985, // PEP_STATEMACHINE_INVALID_ACTION
   129     PEPStatemachineInhibitedEvent                = 0x0986, // PEP_STATEMACHINE_INHIBITED_EVENT
   130     PEPStatemachineCannotSend                    = 0x0987, // PEP_STATEMACHINE_CANNOT_SEND
   131 
   132     PEPCommitFailed                               = 0xff01, // PEP_COMMIT_FAILED
   133     PEPMessageConsume                             = 0xff02, // PEP_MESSAGE_CONSUME
   134     PEPMessageIgnore                              = 0xff03, // PEP_MESSAGE_IGNORE
   135 
   136     PEPRecordNotFound                            = -6, // PEP_RECORD_NOT_FOUND
   137     PEPCannotCreateTempFile                     = -5, // PEP_CANNOT_CREATE_TEMP_FILE
   138     PEPIllegalValue                               = -4, // PEP_ILLEGAL_VALUE
   139     PEPBufferTooSmall                            = -3, // PEP_BUFFER_TOO_SMALL
   140     PEPOutOfMemory                               = -2, // PEP_OUT_OF_MEMORY
   141     PEPUnknownError                               = -1, // PEP_UNKNOWN_ERROR
   142 
   143     PEPVersionMismatch                            = -7, // PEP_VERSION_MISMATCH
   144 } PEPStatus;
   145 
   146 typedef enum _ObjC_identity_flags {
   147     // the first octet flags are app defined settings
   148     PEPIdfNotForSync = 0x0001, // PEP_idf_not_for_sync = 0x0001,   // don't use this identity for sync
   149     PEPIdfList = 0x0002, // PEP_idf_list = 0x0002,           // identity of list of persons
   150     // the second octet flags are calculated
   151     PEPIdfDeviceGroup = 0x0100 // PEP_idf_devicegroup = 0x0100     // identity of a device group member
   152 } PEPIdentityFlags;
   153 
   154 typedef enum _ObjC_sync_handshake_result {
   155     PEPSyncHandshakeResultCancel = -1, // SYNC_HANDSHAKE_CANCEL = -1,
   156     PEPSyncHandshakeResultAccepted = 0, // SYNC_HANDSHAKE_ACCEPTED = 0,
   157     PEPSyncHandshakeResultRejected = 1 // SYNC_HANDSHAKE_REJECTED = 1
   158 } PEPSyncHandshakeResult;
   159 
   160 typedef enum _PEPCommType {
   161     PEPCtUnknown = 0, // PEP_ct_unknown = 0,
   162 
   163     // range 0x01 to 0x09: no encryption, 0x0a to 0x0e: nothing reasonable
   164 
   165     PEPCtNoEncryption = 0x01, // PEP_ct_no_encryption = 0x01,                // generic
   166     PEPCtNoEncrypted_channel = 0x02, // PEP_ct_no_encrypted_channel = 0x02,
   167     PEPCtKeyNotFound = 0x03, // PEP_ct_key_not_found = 0x03,
   168     PEPCtKeyExpired = 0x04, // PEP_ct_key_expired = 0x04,
   169     PEPCtKeyRevoked = 0x05, // PEP_ct_key_revoked = 0x05,
   170     PEPCtKeyBr0ken = 0x06, // PEP_ct_key_b0rken = 0x06,
   171     PEPCtKeyExpiredButConfirmed = 0x07, // PEP_ct_key_expired_but_confirmed = 0x07, // NOT with confirmed bit. Just retaining info here in case of renewal.
   172     PEPCtMyKeyNotIncluded = 0x09, // PEP_ct_my_key_not_included = 0x09,
   173 
   174     PEPCtSecurityByObscurity = 0x0a, // PEP_ct_security_by_obscurity = 0x0a,
   175     PEPCtBr0kenCrypto = 0x0b, // PEP_ct_b0rken_crypto = 0x0b,
   176     PEPCtKeyTooShort = 0x0c, // PEP_ct_key_too_short = 0x0c,
   177 
   178     PEPCtCompromised = 0x0e, // PEP_ct_compromized = 0x0e,                  // deprecated misspelling
   179     PEPCtMistrusted = 0x0f, // PEP_ct_mistrusted = 0x0f,                   // known mistrusted key
   180 
   181     // range 0x10 to 0x3f: unconfirmed encryption
   182 
   183     PEPCtUnconfirmedEncryption = 0x10, // PEP_ct_unconfirmed_encryption = 0x10,       // generic
   184     PEPCtOpenPGPWeakUnconfirmed = 0x11, // PEP_ct_OpenPGP_weak_unconfirmed = 0x11,     // RSA 1024 is weak
   185 
   186     PEPCtToBeChecked = 0x20, // PEP_ct_to_be_checked = 0x20,                // generic
   187     PEPCtSMIMEUnconfirmed = 0x21, // PEP_ct_SMIME_unconfirmed = 0x21,
   188     PEPCtCMSUnconfirmed = 0x22, // PEP_ct_CMS_unconfirmed = 0x22,
   189 
   190     PEPCtStongButUnconfirmed = 0x30, // PEP_ct_strong_but_unconfirmed = 0x30,       // generic
   191     PEPCtOpenPGPUnconfirmed = 0x38, // PEP_ct_OpenPGP_unconfirmed = 0x38,          // key at least 2048 bit RSA or EC
   192     PEPCtOTRUnconfirmed = 0x3a, // PEP_ct_OTR_unconfirmed = 0x3a,
   193 
   194     // range 0x40 to 0x7f: unconfirmed encryption and anonymization
   195 
   196     PEPCtUnconfirmedEncAnon = 0x40, // PEP_ct_unconfirmed_enc_anon = 0x40,         // generic
   197     PEPCtPEPUnconfirmed = 0x7f, // PEP_ct_pEp_unconfirmed = 0x7f,
   198 
   199     PEPCtConfirmed = 0x80, // PEP_ct_confirmed = 0x80,                    // this bit decides if trust is confirmed
   200 
   201     // range 0x81 to 0x8f: reserved
   202     // range 0x90 to 0xbf: confirmed encryption
   203 
   204     PEPCtConfirmedEncryption = 0x90, // PEP_ct_confirmed_encryption = 0x90,         // generic
   205     PEPCtOpenPGPWeak = 0x91, // PEP_ct_OpenPGP_weak = 0x91,                 // RSA 1024 is weak (unused)
   206 
   207     PEPCtToBeCheckedConfirmed = 0xa0, // PEP_ct_to_be_checked_confirmed = 0xa0,      // generic
   208     PEPCtSMIME = 0xa1, // PEP_ct_SMIME = 0xa1,
   209     PEPCtCMS = 0xa2, // PEP_ct_CMS = 0xa2,
   210 
   211     PEPCtStongEncryption = 0xb0, // PEP_ct_strong_encryption = 0xb0,            // generic
   212     PEPCtOpenPGP = 0xb8, // PEP_ct_OpenPGP = 0xb8,                      // key at least 2048 bit RSA or EC
   213     PEPCtOTR = 0xba, // PEP_ct_OTR = 0xba,
   214 
   215     // range 0xc0 to 0xff: confirmed encryption and anonymization
   216 
   217     PEPCtConfirmedEncAnon = 0xc0, // PEP_ct_confirmed_enc_anon = 0xc0,           // generic
   218     PEPCtPEP = 0xff // PEP_ct_pEp = 0xff
   219 } PEPCommType;
   220 
   221 typedef enum _ObjC_PEP_msg_direction {
   222     PEPDirIncoming = 0,
   223     PEPDirOutgoing
   224 } PEPMsgDirection;
   225 
   226 #endif /* PEPTypes_h */