krb5_cc_set_flags()--Set Credentials Cache Processing Flags


  Syntax 
 #include <krb5.h>

 krb5_error_code krb5_cc_set_flags(  
     krb5_context     context,
     krb5_ccache      ccache);  
     krb5_flags       flags);
  Service Program Name: QSYS/QKRBGSS

  Default Public Authority: *USE

  Threadsafe: Yes

The krb5_cc_set_flags() function sets the processing flags for the credentials cache. The interpretation of the flags depends on the cache type.


Authorities

Object Referred to Data Authority Required
Each directory in the path name preceding the credentials cache file *X
Credentials cache file *R


Parameters

context  (Input)
The Kerberos context.

ccache  (Input)
The credentials cache handle.

flags  (Input)
The flags. The allowable flags depends on the cache type. See usage notes.

Return Value

If no errors occur, the return value is 0. Otherwise, a Kerberos error code is returned.


Error Messages

Message ID Error Message Text
CPE3418 E Possible APAR condition or hardware failure.


Usage Notes

  1. The MEMORY cache type does not support the krb5_cc_set_flags() routine and will return KRB5_CC_OP_NOT_SUPPORTED.

  2. The FILE cache type supports the KRB5_TC_OPENCLOSE (x'00000001') flag only. If this flag is specified, the credentials cache file is opened each time a credentials cache routine is called and then closed before returning to the caller. This is the default behavior if the krb5_cc_set_flags() routine is not called. If this flag is not specified, the credentials cache file is opened and remains open until the credentials cache is closed by the krb5_cc_close() or krb5_cc_destroy() routine. The sequential read routines are exceptions. Regardless of the KRB5_TC_OPENCLOSE flag setting, the credentials cache file is opened when the krb5_cc_start_seq_get() routine is called and remains open until the krb5_cc_end_seq_get() routine is called.

API introduced: V5R1

[ Back to top | Security APIs | UNIX-Type APIs | APIs by category ]