librpc/idl/auth.idl

   1 #include "idl_types.h"
   2
   3 /*
   4   Authentication IDL structures
   5
   6   These are NOT public network structures, but it is helpful to define
   7   these things in IDL. They may change without ABI breakage or
   8   warning.
   9
  10 */
  11
  12 import "misc.idl", "security.idl", "lsa.idl", "krb5pac.idl";
  13 [
  14         pyhelper("librpc/ndr/py_auth.c"),
  15         helper("../librpc/ndr/ndr_auth.h"),
  16         helpstring("internal Samba authentication structures")
  17 ]
  18
  19 interface auth
  20 {
  21         typedef [public] enum {
  22                 SEC_AUTH_METHOD_UNAUTHENTICATED = 0,
  23                 SEC_AUTH_METHOD_NTLM            = 1,
  24                 SEC_AUTH_METHOD_KERBEROS        = 2
  25         } auth_method;
  26
  27         /* This is the parts of the session_info that don't change
  28          * during local privilege and group manipulations */
  29         typedef [public] struct {
  30                 [unique,charset(UTF8),string] char *account_name;
  31                 [unique,charset(UTF8),string] char *user_principal_name;
  32                 boolean8 user_principal_constructed;
  33                 [unique,charset(UTF8),string] char *domain_name;
  34                 [unique,charset(UTF8),string] char *dns_domain_name;
  35
  36                 [unique,charset(UTF8),string] char *full_name;
  37                 [unique,charset(UTF8),string] char *logon_script;
  38                 [unique,charset(UTF8),string] char *profile_path;
  39                 [unique,charset(UTF8),string] char *home_directory;
  40                 [unique,charset(UTF8),string] char *home_drive;
  41                 [unique,charset(UTF8),string] char *logon_server;
  42
  43                 NTTIME last_logon;
  44                 NTTIME last_logoff;
  45                 NTTIME acct_expiry;
  46                 NTTIME last_password_change;
  47                 NTTIME allow_password_change;
  48                 NTTIME force_password_change;
  49
  50                 uint16 logon_count;
  51                 uint16 bad_password_count;
  52
  53                 uint32 acct_flags;
  54
  55                 uint8 authenticated;
  56         } auth_user_info;
  57
  58         /* This information is preserved only to assist torture tests */
  59         typedef [public] struct {
  60                 /* Number SIDs from the DC netlogon validation info */
  61                 uint32 num_dc_sids;
  62                 [size_is(num_dc_sids)] dom_sid dc_sids[*];
  63         } auth_user_info_torture;
  64
  65         typedef [public] struct {
  66                 [unique,charset(UTF8),string] char *unix_name;
  67
  68                 /*
  69                  * For performance reasons we keep an alpha_strcpy-sanitized version
  70                  * of the username around as long as the global variable current_user
  71                  * still exists. If we did not do keep this, we'd have to call
  72                  * alpha_strcpy whenever we do a become_user(), potentially on every
  73                  * smb request. See set_current_user_info in source3.
  74                  */
  75                 [unique,charset(UTF8),string] char *sanitized_username;
  76         } auth_user_info_unix;
  77
  78         /* This is the interim product of the auth subsystem, before
  79          * privileges and local groups are handled */
  80         typedef [public] struct {
  81                 uint32 num_sids;
  82                 [size_is(num_sids)] dom_sid sids[*];
  83                 auth_user_info *info;
  84                 [noprint] DATA_BLOB user_session_key;
  85                 [noprint] DATA_BLOB lm_session_key;
  86         } auth_user_info_dc;
  87
  88         typedef [public] struct {
  89                 security_token *security_token;
  90                 security_unix_token *unix_token;
  91                 auth_user_info *info;
  92                 auth_user_info_unix *unix_info;
  93                 [value(NULL), ignore] auth_user_info_torture *torture;
  94
  95                 /* This is the final session key, as used by SMB signing, and
  96                  * (truncated to 16 bytes) encryption on the SAMR and LSA pipes
  97                  * when over ncacn_np.
  98                  * It is calculated by NTLMSSP from the session key in the info3,
  99                  * and is  set from the Kerberos session key using
 100                  * krb5_auth_con_getremotesubkey().
 101                  *
 102                  * Bottom line, it is not the same as the session keys in info3.
 103                  */
 104
 105                 [noprint] DATA_BLOB session_key;
 106
 107                 [value(NULL), ignore] cli_credentials *credentials;
 108
 109                 /*
 110                  * It is really handy to have our authorization code log a
 111                  * token that can be used to tie later requests together.
 112                  * We generate this in auth_generate_session_info()
 113                  */
 114                 GUID unique_session_token;
 115         } auth_session_info;
 116
 117         typedef [public] struct {
 118                 auth_session_info *session_info;
 119                 [noprint] DATA_BLOB exported_gssapi_credentials;
 120         } auth_session_info_transport;
 121 }