doc/html/_sources/appdev/refs/api/krb5_rd_safe.txt

   1 krb5_rd_safe -  Process KRB-SAFE message.
   2 ==========================================
   3
   4 ..
   5
   6 .. c:function:: krb5_error_code krb5_rd_safe(krb5_context context, krb5_auth_context auth_context, const krb5_data * inbuf, krb5_data * outbuf, krb5_replay_data * outdata)
   7
   8 ..
   9
  10
  11 :param:
  12
  13                   **[in]** **context** - Library context
  14
  15                   **[in]** **auth_context** - Authentication context
  16
  17                   **[in]** **inbuf** - **KRB-SAFE** message to be parsed
  18
  19                   **[out]** **outbuf** - Data parsed from **KRB-SAFE** message
  20
  21                   **[out]** **outdata** - Replay data. Specify NULL if not needed
  22
  23
  24 ..
  25
  26
  27 :retval:
  28          -   0   Success; otherwise - Kerberos error codes
  29
  30
  31 ..
  32
  33
  34
  35
  36
  37
  38
  39 This function parses a **KRB-SAFE** message, verifies its integrity, and stores its data into *outbuf* .
  40
  41
  42
  43 If the :data:`KRB5_AUTH_CONTEXT_DO_SEQUENCE` flag is set in *auth_context* , the sequence number of the KRB-SAFE message is checked against the remote sequence number field of *auth_context* . Otherwise, the sequence number is not used.
  44
  45
  46
  47 If the :data:`KRB5_AUTH_CONTEXT_DO_TIME` flag is set in *auth_context* , then two additional checks are performed:
  48
  49          - The timestamp in the message must be within the permitted clock skew (which is usually five minutes).
  50
  51
  52          - The message must not be a replayed message field in *auth_context* .
  53
  54  Use :c:func:`krb5_free_data_contents()` to free *outbuf* when it is no longer needed.
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65 ..
  66
  67
  68
  69
  70
  71
  72 .. note::
  73
  74          The *outdata* argument is required if :data:`KRB5_AUTH_CONTEXT_RET_TIME` or :data:`KRB5_AUTH_CONTEXT_RET_SEQUENCE` flag is set in the *auth_context* .
  75
  76          *auth_context* must have a remote address set. This address will be used to verify the sender address in the KRB-SAFE message. If *auth_context* has a local address set, it will be used to verify the receiver address in the KRB-SAFE message if the message contains one. Both addresses must use type **ADDRTYPE_ADDRPORT** .
  77
  78
  79
  80