2 samba -- Unix SMB/CIFS implementation.
4 Client credentials structure
6 Copyright (C) Jelmer Vernooij 2004-2005
7 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program; if not, write to the Free Software
21 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23 #ifndef __CREDENTIALS_H__
24 #define __CREDENTIALS_H__
26 struct ccache_container;
28 /* In order of priority */
29 enum credentials_obtained {
30 CRED_UNINITIALISED = 0, /* We don't even have a guess yet */
31 CRED_GUESS_ENV, /* Current value should be used, which was guessed */
32 CRED_CALLBACK, /* Callback should be used to obtain value */
33 CRED_GUESS_FILE, /* A guess from a file (or file pointed at in env variable) */
34 CRED_SPECIFIED /* Was explicitly specified on the command-line */
37 enum credentials_use_kerberos {
38 CRED_AUTO_USE_KERBEROS = 0, /* Default, we try kerberos if available */
39 CRED_DONT_USE_KERBEROS, /* Sometimes trying kerberos just does 'bad things', so don't */
40 CRED_MUST_USE_KERBEROS /* Sometimes administrators are parinoid, so always do kerberos */
43 #define CLI_CRED_NTLM2 0x01
44 #define CLI_CRED_NTLMv2_AUTH 0x02
45 #define CLI_CRED_LANMAN_AUTH 0x04
46 #define CLI_CRED_NTLM_AUTH 0x08
47 #define CLI_CRED_CLEAR_AUTH 0x10 /* TODO: Push cleartext auth with this flag */
49 struct cli_credentials {
50 enum credentials_obtained workstation_obtained;
51 enum credentials_obtained username_obtained;
52 enum credentials_obtained password_obtained;
53 enum credentials_obtained domain_obtained;
54 enum credentials_obtained realm_obtained;
55 enum credentials_obtained ccache_obtained;
56 enum credentials_obtained client_gss_creds_obtained;
57 enum credentials_obtained principal_obtained;
58 enum credentials_obtained keytab_obtained;
59 enum credentials_obtained server_gss_creds_obtained;
61 const char *workstation;
64 const char *old_password;
67 const char *principal;
68 const char *salt_principal;
72 struct samr_Password *nt_hash;
74 struct ccache_container *ccache;
75 struct gssapi_creds_container *client_gss_creds;
76 struct keytab_container *keytab;
77 struct gssapi_creds_container *server_gss_creds;
79 const char *(*workstation_cb) (struct cli_credentials *);
80 const char *(*password_cb) (struct cli_credentials *);
81 const char *(*username_cb) (struct cli_credentials *);
82 const char *(*domain_cb) (struct cli_credentials *);
83 const char *(*realm_cb) (struct cli_credentials *);
84 const char *(*principal_cb) (struct cli_credentials *);
86 /* Private handle for the callback routines to use */
89 struct creds_CredentialState *netlogon_creds;
90 enum netr_SchannelType secure_channel_type;
93 struct smb_krb5_context *smb_krb5_context;
95 /* We are flagged to get machine account details from the
96 * secrets.ldb when we are asked for a username or password */
98 BOOL machine_account_pending;
100 /* Is this a machine account? */
101 BOOL machine_account;
103 /* Should we be trying to use kerberos? */
104 enum credentials_use_kerberos use_kerberos;
107 #include "auth/credentials/credentials_proto.h"
109 #endif /* __CREDENTIALS_H__ */