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