src/keymanagement.h
author Volker Birk <vb@pep.foundation>
Wed, 29 Aug 2018 17:10:23 +0200
branchsync
changeset 2899 63b619aef131
parent 2834 7a35e7ea6138
child 2955 3b2500a15709
child 2981 39a510d16cdd
permissions -rw-r--r--
somewhat bigger
     1 // This file is under GNU General Public License 3.0
     2 // see LICENSE.txt
     3 
     4 #pragma once
     5 
     6 #include "pEpEngine.h"
     7 
     8 #ifdef __cplusplus
     9 extern "C" {
    10 #endif
    11 
    12 // update_identity() - update identity information
    13 //
    14 //  parameters:
    15 //      session (in)        session to use
    16 //      identity (inout)    identity information of communication partner
    17 //                          (identity->fpr is OUT ONLY), and at least
    18 //                          .address must be set. 
    19 //                          If .username is set, it will be used to set or patch
    20 //                          the username record for this identity.                         
    21 //  return value:
    22 //      PEP_STATUS_OK if identity could be updated,
    23 //      PEP_ILLEGAL_VALUE if called with illegal inputs, including an identity
    24 //                        with .me set or with an own user_id specified in the
    25 //                        *input* (see caveats) 
    26 //      PEP_KEY_UNSUITABLE if a default key was found for this identity, no
    27 //                         other acceptable keys were found; if this is returned,
    28 //                         the reason for rejecting the first default key found
    29 //                         may be found in the comm_type
    30 //      any other value on error
    31 //
    32 //  caveat:
    33 //      at least identity->address must be a non-empty UTF-8 string as input
    34 //      update_identity() never writes flags; use set_identity_flags() for
    35 //      writing
    36 //      this function NEVER reads the incoming fpr, only writes to it.
    37 //      this function will fail if called on an identity which, with its input
    38 //      values, *explicitly* indicates it is an own identity (i.e. .me is set
    39 //      to true on input, or a user_id is given AND it is a known own user_id).
    40 //      however, it can RETURN an own identity if this is not indicated a
    41 //      priori, and in fact will do so with prejudice when not faced with a
    42 //      matching default (i.e. it is forced to search by address only).
    43 //      if the identity is known to be an own identity (or the caller wishes
    44 //      to make it one), call myself() on the identity instead.
    45 //
    46 //      FIXME: is this next point accurate?
    47 //      if this function returns PEP_ct_unknown or PEP_ct_key_expired in
    48 //      identity->comm_type, the caller must insert the identity into the
    49 //      asynchronous management implementation, so retrieve_next_identity()
    50 //      will return this identity later
    51 //      END FIXME
    52 
    53 DYNAMIC_API PEP_STATUS update_identity(
    54         PEP_SESSION session, pEp_identity * identity
    55     );
    56 
    57 // TODO: remove
    58 // initialise_own_identities () - ensures that an own identity is complete
    59 //
    60 //  parameters:
    61 //      session (in)        session to use
    62 //      my_idents (inout)   identities of local user to quick-set
    63 //                          For these, at least .address must be set.
    64 //                          if no .user_id is set, AND the DB doesn't contain
    65 //                          a default user_id, PEP_OWN_USERID will be used and
    66 //                          become the perennial default for the DB.
    67 //
    68 //  return value:
    69 //      PEP_STATUS_OK if identity could be set,
    70 //      any other value on error
    71 //
    72 //  caveat:
    73 //      this function does NOT generate keypairs. It is intended to
    74 //      precede running of the engine on actual messages. It effectively
    75 //      behaves like myself(), but when there would normally be key generation
    76 //      (when there is no valid key, for example),
    77 //      it instead stores an identity without keys.
    78 //
    79 //      N.B. to adapter devs - this function is likely unnecessary, so please
    80 //      do not put work into exposing it yet. Tickets will be filed if need be.
    81 
    82 // DYNAMIC_API PEP_STATUS initialise_own_identities(PEP_SESSION session,
    83 //                                                  identity_list* my_idents);
    84 
    85 // myself() - ensures that an own identity is complete
    86 //
    87 //  parameters:
    88 //      session (in)        session to use
    89 //      identity (inout)    identity of local user
    90 //                          both .address and .user_id must be set.
    91 //                          if .fpr is set, an attempt will be made to make
    92 //                          that the default key for this identity after key
    93 //                          validation
    94 //                          if .fpr is not set, key retrieval is performed
    95 //                          If .username is set, it will be used to set or patch
    96 //                          the username record for this identity.                         
    97 //
    98 //  return value:
    99 //      PEP_STATUS_OK if identity could be completed or was already complete,
   100 //      any other value on error
   101 //  caveat:
   102 //      If an fpr was entered and is not a valid key, the reason for failure
   103 //      is immediately returned in the status and, possibly, identity->comm_type
   104 //      If a default own user_id exists in the database, an alias will 
   105 //      be created for the default for the input user_id. The ENGINE'S default
   106 //      user_id is always returned in the .user_id field
   107 //      myself() NEVER elects keys from the keyring; it will only choose keys
   108 //      which have been set up explicitly via myself(), or which were imported
   109 //      during a first time DB setup from an OpenPGP keyring (compatibility only) 
   110 //      this function generates a keypair on demand; because it's synchronous
   111 //      it can need a decent amount of time to return
   112 //      if you need to do this asynchronous, you need to return an identity
   113 //      with retrieve_next_identity() where pEp_identity.me is true
   114 
   115 DYNAMIC_API PEP_STATUS myself(PEP_SESSION session, pEp_identity * identity);
   116 
   117 PEP_STATUS _myself(PEP_SESSION session, pEp_identity * identity, bool do_keygen, bool ignore_flags);
   118 
   119 // retrieve_next_identity() - callback being called by do_keymanagement()
   120 //
   121 //  parameters:
   122 //      management (in)     data structure to deliver (implementation defined)
   123 //
   124 //  return value:
   125 //      identity to check or NULL to terminate do_keymanagement()
   126 //      if given identity must be created with new_identity()
   127 //      the identity struct is going to the ownership of this library
   128 //      it must not be freed by the callee
   129 //
   130 //  caveat:
   131 //      this callback has to block until an identity or NULL can be returned
   132 //      an implementation is not provided by this library; instead it has to be
   133 //      implemented by the user of this library
   134 
   135 typedef pEp_identity *(*retrieve_next_identity_t)(void *management);
   136 
   137 
   138 // examine_identity() - callback for appending to queue
   139 //
   140 //  parameters:
   141 //      ident (in)          identity to examine
   142 //      management (in)     data structure to deliver (implementation defined)
   143 //
   144 //  return value:
   145 //      0 if identity was added successfully to queue or nonzero otherwise
   146 
   147 typedef int (*examine_identity_t)(pEp_identity *ident, void *management);
   148 
   149 
   150 // register_examine_function() - register examine_identity() callback
   151 //
   152 //  parameters:
   153 //      session (in)            session to use
   154 //      examine_identity (in)   examine_identity() function to register
   155 //      management (in)     data structure to deliver (implementation defined)
   156 
   157 DYNAMIC_API PEP_STATUS register_examine_function(
   158         PEP_SESSION session, 
   159         examine_identity_t examine_identity,
   160         void *management
   161     );
   162 
   163 
   164 // do_keymanagement() - function to be run on an extra thread
   165 //
   166 //  parameters:
   167 //      session (in)                session to use
   168 //      retrieve_next_identity (in) pointer to retrieve_next_identity()
   169 //                                  callback which returns at least a valid
   170 //                                  address field in the identity struct
   171 //      messageToSend (in)          callback for sending message by the
   172 //                                  application
   173 //      management (in)             management data to give to keymanagement
   174 //                                  (implementation defined)
   175 //
   176 //  return value:
   177 //      PEP_STATUS_OK if thread has to terminate successfully or any other
   178 //      value on failure
   179 //
   180 //  caveat:
   181 //      to ensure proper working of this library, a thread has to be started
   182 //      with this function immediately after initialization
   183 //
   184 //      do_keymanagement() calls retrieve_next_identity(management)
   185 //
   186 //      messageToSend can only be null if no transport is application based
   187 //      if transport system is not used it must not be NULL
   188 
   189 DYNAMIC_API PEP_STATUS do_keymanagement(
   190         PEP_SESSION session,
   191         retrieve_next_identity_t retrieve_next_identity,
   192         messageToSend_t messageToSend,
   193         void *management
   194     );
   195 
   196 
   197 // key_mistrusted() - mark key as being compromised
   198 //
   199 //  parameters:
   200 //      session (in)        session to use
   201 //      ident (in)          person and key which was compromised
   202 //  caveat:
   203 //      ident is INPUT ONLY. If you want updated trust on the identity, you'll have
   204 //      to call update_identity or myself respectively after this.
   205 //      N.B. If you are calling this on a key that is the identity or user default,
   206 //      it will be removed as the default key for ANY identity and user for which
   207 //      it is the default. Please keep in mind that the undo in undo_last_mistrust
   208 //      will only undo the current identity's / it's user's default, not any
   209 //      other identities which may be impacted (this will not affect most use
   210 //      cases)
   211 
   212 DYNAMIC_API PEP_STATUS key_mistrusted(
   213         PEP_SESSION session,
   214         pEp_identity *ident
   215     );
   216 
   217 // undo_last_mistrust() - reset identity and trust status for the last
   218 //                        identity in this session marked as mistrusted
   219 //                        to their cached values from the time of mistrust
   220 //  parameters:
   221 //      session (in)        session to use
   222 //
   223 //  return value:
   224 //      PEP_STATUS_OK if identity and trust were successfully restored.
   225 //      Otherwise, error status from attempts to set.
   226 //
   227 //  caveat:
   228 //      only works for this session, and only once. cache is invalidated
   229 //      upon use.
   230 //
   231 //      WILL NOT WORK ON MISTRUSTED OWN KEY
   232 
   233 DYNAMIC_API PEP_STATUS undo_last_mistrust(PEP_SESSION session);
   234 
   235 
   236 // trust_personal_key() - mark a key as trusted for a user
   237 //
   238 //  parameters:
   239 //      session (in)        session to use
   240 //      ident (in)          person and key to trust in
   241 //
   242 //  caveat:
   243 //      the fields user_id, address and fpr must be supplied
   244 //      for non-own users, this will 1) set the trust bit on its comm type in the DB,
   245 //      2) set this key as the identity default if the current identity default
   246 //      is not trusted, and 3) set this key as the user default if the current
   247 //      user default is not trusted.
   248 //      For an own user, this is simply a call to myself().
   249 
   250 DYNAMIC_API PEP_STATUS trust_personal_key(
   251         PEP_SESSION session,
   252         pEp_identity *ident
   253     );
   254 
   255 
   256 // key_reset_trust() - reset trust bit or explicitly mistrusted status for an identity and
   257 //                     its accompanying key/user_id pair.
   258 //  parameters:
   259 //      session (in)        session to use
   260 //      ident (in)          identity for person and key whose trust status is to be reset
   261 //
   262 //  caveat:
   263 //      ident is INPUT ONLY. If you want updated trust on the identity, you'll have
   264 //      to call update_identity or myself respectively after this.
   265 //      N.B. If you are calling this on a key that is the identity or user default,
   266 //      it will be removed as the default key for the identity and user (but is still
   267 //      available for key election, it is just not the cached default anymore)
   268 
   269 DYNAMIC_API PEP_STATUS key_reset_trust(
   270         PEP_SESSION session,
   271         pEp_identity *ident
   272     );
   273 
   274 // own_key_is_listed() - returns true id key is listed as own key
   275 //
   276 //  parameters:
   277 //      session (in)        session to use
   278 //      fpr (in)            fingerprint of key to test
   279 //      listed (out)        flags if key is own
   280 
   281 DYNAMIC_API PEP_STATUS own_key_is_listed(
   282         PEP_SESSION session,
   283         const char *fpr,
   284         bool *listed
   285     );
   286 
   287 
   288 // _own_identities_retrieve() - retrieve all own identities
   289 //
   290 //  parameters:
   291 //      session (in)            session to use
   292 //      own_identities (out)    list of own identities
   293 //      excluded_flags (int)    flags to exclude from results
   294 //
   295 //  caveat:
   296 //      the ownership of the copy of own_identities goes to the caller
   297 
   298 DYNAMIC_API PEP_STATUS _own_identities_retrieve(
   299         PEP_SESSION session,
   300         identity_list **own_identities,
   301         identity_flags_t excluded_flags
   302     );
   303 
   304 // own_identities_retrieve() - retrieve all own identities
   305 //
   306 //  parameters:
   307 //      session (in)            session to use
   308 //      own_identities (out)    list of own identities
   309 //
   310 //  caveat:
   311 //      the ownership of the copy of own_identities goes to the caller
   312 
   313 DYNAMIC_API PEP_STATUS own_identities_retrieve(
   314         PEP_SESSION session,
   315         identity_list **own_identities
   316     );
   317 
   318 PEP_STATUS contains_priv_key(PEP_SESSION session, const char *fpr,
   319                              bool *has_private);
   320 
   321 // _own_keys_retrieve() - retrieve all flagged keypair fingerprints 
   322 //
   323 //  parameters:
   324 //      session (in)            session to use
   325 //      keylist (out)           list of fingerprints
   326 //      excluded_flags (int)    flags to exclude from results
   327 //
   328 //  caveat:
   329 //      the ownership of the list goes to the caller
   330 DYNAMIC_API PEP_STATUS _own_keys_retrieve(
   331         PEP_SESSION session,
   332         stringlist_t **keylist,
   333         identity_flags_t excluded_flags
   334       );
   335 
   336 // own_keys_retrieve() - retrieve all flagged keypair fingerprints 
   337 //
   338 //  parameters:
   339 //      session (in)            session to use
   340 //      keylist (out)           list of fingerprints
   341 //
   342 //  caveat:
   343 //      the ownership of the list goes to the caller
   344 DYNAMIC_API PEP_STATUS own_keys_retrieve(
   345         PEP_SESSION session,
   346         stringlist_t **keylist
   347       );
   348 
   349 // set_own_key() - mark a key as own key
   350 //
   351 //  parameters:
   352 //      session (in)            session to use
   353 //      me (inout)              own identity this key is used for
   354 //      fpr (in)                fingerprint of the key to mark as own key
   355 //
   356 //  caveat:
   357 //      the key has to be in the key ring already
   358 //      me->address, me->user_id and me->username must be set to valid data
   359 //      myself() is called by set_own_key() without key generation
   360 //      me->flags are ignored
   361 //      me->address must not be an alias
   362 //      me->fpr will be ignored and replaced by fpr
   363 
   364 DYNAMIC_API PEP_STATUS set_own_key(
   365        PEP_SESSION session,
   366        pEp_identity *me,
   367        const char *fpr
   368     );
   369 
   370 PEP_STATUS _myself(PEP_SESSION session, pEp_identity * identity, bool do_keygen, bool ignore_flags);
   371 
   372 PEP_STATUS add_mistrusted_key(PEP_SESSION session, const char* fpr);
   373 PEP_STATUS delete_mistrusted_key(PEP_SESSION session, const char* fpr);
   374 PEP_STATUS is_mistrusted_key(PEP_SESSION session, const char* fpr, bool* mistrusted);
   375 PEP_STATUS get_user_default_key(PEP_SESSION session, const char* user_id,
   376                                 char** default_key);
   377 
   378 
   379 
   380 
   381 // Only call on retrieval of previously stored identity!
   382 // Also, we presume that if the stored_identity was sent in
   383 // without an fpr, there wasn't one in the trust DB for this
   384 // identity.
   385 PEP_STATUS get_valid_pubkey(PEP_SESSION session,
   386                             pEp_identity* stored_identity,
   387                             bool* is_identity_default,
   388                             bool* is_user_default,
   389                             bool* is_address_default,
   390                             bool check_blacklist);
   391 
   392 #ifdef __cplusplus
   393 }
   394 #endif