2004-04-04 20:24:08 +04:00
/*
2004-12-10 23:07:04 +03:00
samba - - Unix SMB / CIFS implementation .
Client credentials structure
2006-05-03 18:15:31 +04:00
Copyright ( C ) Jelmer Vernooij 2004 - 2006
2005-03-24 06:32:25 +03:00
Copyright ( C ) Andrew Bartlett < abartlet @ samba . org > 2005
2004-12-10 23:07:04 +03:00
2004-04-04 20:24:08 +04:00
This program is free software ; you can redistribute it and / or modify
it under the terms of the GNU General Public License as published by
2007-07-10 06:07:03 +04:00
the Free Software Foundation ; either version 3 of the License , or
2004-04-04 20:24:08 +04:00
( at your option ) any later version .
This program is distributed in the hope that it will be useful ,
but WITHOUT ANY WARRANTY ; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
GNU General Public License for more details .
You should have received a copy of the GNU General Public License
2007-07-10 06:07:03 +04:00
along with this program . If not , see < http : //www.gnu.org/licenses/>.
2004-04-04 20:24:08 +04:00
*/
2006-03-14 04:29:56 +03:00
# ifndef __CREDENTIALS_H__
# define __CREDENTIALS_H__
2004-04-04 20:24:08 +04:00
2008-10-11 23:05:38 +04:00
# include "../lib/util/data_blob.h"
2006-03-16 20:51:04 +03:00
# include "librpc/gen_ndr/misc.h"
2013-07-31 14:41:40 +04:00
struct cli_credentials ;
2005-09-26 19:59:43 +04:00
struct ccache_container ;
2008-12-29 22:24:57 +03:00
struct tevent_context ;
2011-10-09 16:27:44 +04:00
struct netlogon_creds_CredentialState ;
2013-07-31 14:41:40 +04:00
struct ldb_context ;
struct ldb_message ;
struct loadparm_context ;
struct ccache_container ;
struct gssapi_creds_container ;
struct smb_krb5_context ;
struct keytab_container ;
2005-09-26 19:59:43 +04:00
2005-03-21 05:08:38 +03:00
/* In order of priority */
enum credentials_obtained {
2005-04-10 14:11:36 +04:00
CRED_UNINITIALISED = 0 , /* We don't even have a guess yet */
2005-03-21 05:08:38 +03:00
CRED_CALLBACK , /* Callback should be used to obtain value */
2007-03-07 07:20:10 +03:00
CRED_GUESS_ENV , /* Current value should be used, which was guessed */
2005-08-29 08:30:22 +04:00
CRED_GUESS_FILE , /* A guess from a file (or file pointed at in env variable) */
2006-05-03 18:15:31 +04:00
CRED_CALLBACK_RESULT , /* Value was obtained from a callback */
2005-03-21 05:08:38 +03:00
CRED_SPECIFIED /* Was explicitly specified on the command-line */
} ;
2006-01-28 15:15:24 +03:00
enum credentials_use_kerberos {
CRED_AUTO_USE_KERBEROS = 0 , /* Default, we try kerberos if available */
CRED_DONT_USE_KERBEROS , /* Sometimes trying kerberos just does 'bad things', so don't */
CRED_MUST_USE_KERBEROS /* Sometimes administrators are parinoid, so always do kerberos */
} ;
2010-09-16 08:12:37 +04:00
enum credentials_krb_forwardable {
CRED_AUTO_KRB_FORWARDABLE = 0 , /* Default, follow library defaults */
CRED_NO_KRB_FORWARDABLE , /* not forwardable */
CRED_FORCE_KRB_FORWARDABLE /* forwardable */
} ;
2005-10-14 08:04:52 +04:00
# define CLI_CRED_NTLM2 0x01
# define CLI_CRED_NTLMv2_AUTH 0x02
# define CLI_CRED_LANMAN_AUTH 0x04
# define CLI_CRED_NTLM_AUTH 0x08
2006-01-28 15:15:24 +03:00
# define CLI_CRED_CLEAR_AUTH 0x10 /* TODO: Push cleartext auth with this flag */
2005-10-14 08:04:52 +04:00
2008-04-02 06:53:27 +04:00
const char * cli_credentials_get_workstation ( struct cli_credentials * cred ) ;
bool cli_credentials_set_workstation ( struct cli_credentials * cred ,
const char * val ,
enum credentials_obtained obtained ) ;
bool cli_credentials_is_anonymous ( struct cli_credentials * cred ) ;
struct cli_credentials * cli_credentials_init ( TALLOC_CTX * mem_ctx ) ;
void cli_credentials_set_anonymous ( struct cli_credentials * cred ) ;
bool cli_credentials_wrong_password ( struct cli_credentials * cred ) ;
const char * cli_credentials_get_password ( struct cli_credentials * cred ) ;
void cli_credentials_get_ntlm_username_domain ( struct cli_credentials * cred , TALLOC_CTX * mem_ctx ,
const char * * username ,
const char * * domain ) ;
NTSTATUS cli_credentials_get_ntlm_response ( struct cli_credentials * cred , TALLOC_CTX * mem_ctx ,
int * flags ,
DATA_BLOB challenge , DATA_BLOB target_info ,
DATA_BLOB * _lm_response , DATA_BLOB * _nt_response ,
DATA_BLOB * _lm_session_key , DATA_BLOB * _session_key ) ;
const char * cli_credentials_get_realm ( struct cli_credentials * cred ) ;
const char * cli_credentials_get_username ( struct cli_credentials * cred ) ;
int cli_credentials_get_krb5_context ( struct cli_credentials * cred ,
struct loadparm_context * lp_ctx ,
struct smb_krb5_context * * smb_krb5_context ) ;
int cli_credentials_get_ccache ( struct cli_credentials * cred ,
2008-12-29 22:24:57 +03:00
struct tevent_context * event_ctx ,
2008-04-02 06:53:27 +04:00
struct loadparm_context * lp_ctx ,
2010-02-25 08:16:33 +03:00
struct ccache_container * * ccc ,
const char * * error_string ) ;
2010-02-20 03:44:41 +03:00
int cli_credentials_get_named_ccache ( struct cli_credentials * cred ,
struct tevent_context * event_ctx ,
struct loadparm_context * lp_ctx ,
char * ccache_name ,
2010-02-25 08:16:33 +03:00
struct ccache_container * * ccc , const char * * error_string ) ;
2012-10-31 10:58:20 +04:00
bool cli_credentials_failed_kerberos_login ( struct cli_credentials * cred ,
const char * principal ,
unsigned int * count ) ;
2008-04-02 06:53:27 +04:00
int cli_credentials_get_keytab ( struct cli_credentials * cred ,
struct loadparm_context * lp_ctx ,
struct keytab_container * * _ktc ) ;
const char * cli_credentials_get_domain ( struct cli_credentials * cred ) ;
2009-04-06 16:54:44 +04:00
struct netlogon_creds_CredentialState * cli_credentials_get_netlogon_creds ( struct cli_credentials * cred ) ;
2008-04-02 06:53:27 +04:00
void cli_credentials_set_machine_account_pending ( struct cli_credentials * cred ,
struct loadparm_context * lp_ctx ) ;
void cli_credentials_set_conf ( struct cli_credentials * cred ,
struct loadparm_context * lp_ctx ) ;
const char * cli_credentials_get_principal ( struct cli_credentials * cred , TALLOC_CTX * mem_ctx ) ;
int cli_credentials_get_server_gss_creds ( struct cli_credentials * cred ,
struct loadparm_context * lp_ctx ,
struct gssapi_creds_container * * _gcc ) ;
int cli_credentials_get_client_gss_creds ( struct cli_credentials * cred ,
2008-12-29 22:24:57 +03:00
struct tevent_context * event_ctx ,
2008-04-02 06:53:27 +04:00
struct loadparm_context * lp_ctx ,
2010-02-25 08:16:33 +03:00
struct gssapi_creds_container * * _gcc ,
const char * * error_string ) ;
2013-09-16 20:38:09 +04:00
void cli_credentials_set_forced_sasl_mech ( struct cli_credentials * creds ,
const char * sasl_mech ) ;
2008-04-02 06:53:27 +04:00
void cli_credentials_set_kerberos_state ( struct cli_credentials * creds ,
enum credentials_use_kerberos use_kerberos ) ;
2010-09-16 08:12:37 +04:00
void cli_credentials_set_krb_forwardable ( struct cli_credentials * creds ,
enum credentials_krb_forwardable krb_forwardable ) ;
2008-04-02 06:53:27 +04:00
bool cli_credentials_set_domain ( struct cli_credentials * cred ,
const char * val ,
enum credentials_obtained obtained ) ;
2009-01-25 07:32:30 +03:00
bool cli_credentials_set_domain_callback ( struct cli_credentials * cred ,
const char * ( * domain_cb ) ( struct cli_credentials * ) ) ;
2008-04-02 06:53:27 +04:00
bool cli_credentials_set_username ( struct cli_credentials * cred ,
const char * val , enum credentials_obtained obtained ) ;
2009-01-25 07:32:30 +03:00
bool cli_credentials_set_username_callback ( struct cli_credentials * cred ,
const char * ( * username_cb ) ( struct cli_credentials * ) ) ;
bool cli_credentials_set_principal ( struct cli_credentials * cred ,
const char * val ,
enum credentials_obtained obtained ) ;
bool cli_credentials_set_principal_callback ( struct cli_credentials * cred ,
const char * ( * principal_cb ) ( struct cli_credentials * ) ) ;
2008-04-02 06:53:27 +04:00
bool cli_credentials_set_password ( struct cli_credentials * cred ,
const char * val ,
enum credentials_obtained obtained ) ;
struct cli_credentials * cli_credentials_init_anon ( TALLOC_CTX * mem_ctx ) ;
void cli_credentials_parse_string ( struct cli_credentials * credentials , const char * data , enum credentials_obtained obtained ) ;
2013-08-09 12:15:05 +04:00
struct samr_Password * cli_credentials_get_nt_hash ( struct cli_credentials * cred ,
TALLOC_CTX * mem_ctx ) ;
2008-04-02 06:53:27 +04:00
bool cli_credentials_set_realm ( struct cli_credentials * cred ,
const char * val ,
enum credentials_obtained obtained ) ;
void cli_credentials_set_secure_channel_type ( struct cli_credentials * cred ,
enum netr_SchannelType secure_channel_type ) ;
2010-05-17 07:41:01 +04:00
void cli_credentials_set_password_last_changed_time ( struct cli_credentials * cred ,
time_t last_change_time ) ;
2008-04-02 06:53:27 +04:00
void cli_credentials_set_netlogon_creds ( struct cli_credentials * cred ,
2009-04-06 16:54:44 +04:00
struct netlogon_creds_CredentialState * netlogon_creds ) ;
2008-04-02 06:53:27 +04:00
NTSTATUS cli_credentials_set_krb5_context ( struct cli_credentials * cred ,
struct smb_krb5_context * smb_krb5_context ) ;
NTSTATUS cli_credentials_set_stored_principal ( struct cli_credentials * cred ,
struct loadparm_context * lp_ctx ,
const char * serviceprincipal ) ;
NTSTATUS cli_credentials_set_machine_account ( struct cli_credentials * cred ,
struct loadparm_context * lp_ctx ) ;
bool cli_credentials_authentication_requested ( struct cli_credentials * cred ) ;
void cli_credentials_guess ( struct cli_credentials * cred ,
struct loadparm_context * lp_ctx ) ;
bool cli_credentials_set_bind_dn ( struct cli_credentials * cred ,
const char * bind_dn ) ;
const char * cli_credentials_get_bind_dn ( struct cli_credentials * cred ) ;
bool cli_credentials_parse_file ( struct cli_credentials * cred , const char * file , enum credentials_obtained obtained ) ;
const char * cli_credentials_get_unparsed_name ( struct cli_credentials * credentials , TALLOC_CTX * mem_ctx ) ;
bool cli_credentials_set_password_callback ( struct cli_credentials * cred ,
const char * ( * password_cb ) ( struct cli_credentials * ) ) ;
enum netr_SchannelType cli_credentials_get_secure_channel_type ( struct cli_credentials * cred ) ;
2010-05-17 07:41:01 +04:00
time_t cli_credentials_get_password_last_changed_time ( struct cli_credentials * cred ) ;
2008-04-02 06:53:27 +04:00
void cli_credentials_set_kvno ( struct cli_credentials * cred ,
int kvno ) ;
bool cli_credentials_set_nt_hash ( struct cli_credentials * cred ,
const struct samr_Password * nt_hash ,
enum credentials_obtained obtained ) ;
2008-05-05 06:58:15 +04:00
bool cli_credentials_set_ntlm_response ( struct cli_credentials * cred ,
const DATA_BLOB * lm_response ,
const DATA_BLOB * nt_response ,
enum credentials_obtained obtained ) ;
2008-04-02 06:53:27 +04:00
int cli_credentials_set_keytab_name ( struct cli_credentials * cred ,
struct loadparm_context * lp_ctx ,
const char * keytab_name ,
enum credentials_obtained obtained ) ;
void cli_credentials_set_gensec_features ( struct cli_credentials * creds , uint32_t gensec_features ) ;
uint32_t cli_credentials_get_gensec_features ( struct cli_credentials * creds ) ;
int cli_credentials_set_ccache ( struct cli_credentials * cred ,
struct loadparm_context * lp_ctx ,
const char * name ,
2010-02-25 08:16:33 +03:00
enum credentials_obtained obtained ,
const char * * error_string ) ;
2008-04-02 06:53:27 +04:00
bool cli_credentials_parse_password_file ( struct cli_credentials * credentials , const char * file , enum credentials_obtained obtained ) ;
bool cli_credentials_parse_password_fd ( struct cli_credentials * credentials ,
int fd , enum credentials_obtained obtained ) ;
void cli_credentials_invalidate_ccache ( struct cli_credentials * cred ,
enum credentials_obtained obtained ) ;
void cli_credentials_set_salt_principal ( struct cli_credentials * cred , const char * principal ) ;
2011-04-22 13:22:50 +04:00
void cli_credentials_set_impersonate_principal ( struct cli_credentials * cred ,
const char * principal ,
const char * self_service ) ;
2010-03-03 05:24:52 +03:00
void cli_credentials_set_target_service ( struct cli_credentials * cred , const char * principal ) ;
const char * cli_credentials_get_salt_principal ( struct cli_credentials * cred ) ;
const char * cli_credentials_get_impersonate_principal ( struct cli_credentials * cred ) ;
2011-04-22 13:22:50 +04:00
const char * cli_credentials_get_self_service ( struct cli_credentials * cred ) ;
2010-03-03 05:24:52 +03:00
const char * cli_credentials_get_target_service ( struct cli_credentials * cred ) ;
2008-04-02 06:53:27 +04:00
enum credentials_use_kerberos cli_credentials_get_kerberos_state ( struct cli_credentials * creds ) ;
2013-09-16 20:38:09 +04:00
const char * cli_credentials_get_forced_sasl_mech ( struct cli_credentials * cred ) ;
2010-09-16 08:12:37 +04:00
enum credentials_krb_forwardable cli_credentials_get_krb_forwardable ( struct cli_credentials * creds ) ;
2008-04-02 06:53:27 +04:00
NTSTATUS cli_credentials_set_secrets ( struct cli_credentials * cred ,
struct loadparm_context * lp_ctx ,
struct ldb_context * ldb ,
const char * base ,
2010-02-20 03:44:41 +03:00
const char * filter ,
char * * error_string ) ;
2008-04-02 06:53:27 +04:00
int cli_credentials_get_kvno ( struct cli_credentials * cred ) ;
2006-03-14 04:29:56 +03:00
2011-10-09 16:27:44 +04:00
bool cli_credentials_set_username_callback ( struct cli_credentials * cred ,
const char * ( * username_cb ) ( struct cli_credentials * ) ) ;
/**
* Obtain the client principal for this credentials context .
* @ param cred credentials context
* @ retval The username set on this context .
* @ note Return value will never be NULL except by programmer error .
*/
const char * cli_credentials_get_principal_and_obtained ( struct cli_credentials * cred , TALLOC_CTX * mem_ctx , enum credentials_obtained * obtained ) ;
bool cli_credentials_set_principal ( struct cli_credentials * cred ,
const char * val ,
enum credentials_obtained obtained ) ;
bool cli_credentials_set_principal_callback ( struct cli_credentials * cred ,
const char * ( * principal_cb ) ( struct cli_credentials * ) ) ;
/**
* Obtain the ' old ' password for this credentials context ( used for join accounts ) .
* @ param cred credentials context
* @ retval If set , the cleartext password , otherwise NULL
*/
const char * cli_credentials_get_old_password ( struct cli_credentials * cred ) ;
bool cli_credentials_set_old_password ( struct cli_credentials * cred ,
const char * val ,
enum credentials_obtained obtained ) ;
bool cli_credentials_set_domain_callback ( struct cli_credentials * cred ,
const char * ( * domain_cb ) ( struct cli_credentials * ) ) ;
bool cli_credentials_set_realm_callback ( struct cli_credentials * cred ,
const char * ( * realm_cb ) ( struct cli_credentials * ) ) ;
bool cli_credentials_set_workstation_callback ( struct cli_credentials * cred ,
const char * ( * workstation_cb ) ( struct cli_credentials * ) ) ;
2013-07-31 14:52:17 +04:00
void cli_credentials_set_callback_data ( struct cli_credentials * cred ,
void * callback_data ) ;
void * _cli_credentials_callback_data ( struct cli_credentials * cred ) ;
# define cli_credentials_callback_data(_cred, _type) \
talloc_get_type_abort ( _cli_credentials_callback_data ( _cred ) , _type )
# define cli_credentials_callback_data_void(_cred) \
_cli_credentials_callback_data ( _cred )
2013-07-31 15:21:14 +04:00
struct cli_credentials * cli_credentials_shallow_copy ( TALLOC_CTX * mem_ctx ,
struct cli_credentials * src ) ;
2011-10-09 16:27:44 +04:00
/**
* Return attached NETLOGON credentials
*/
struct netlogon_creds_CredentialState * cli_credentials_get_netlogon_creds ( struct cli_credentials * cred ) ;
2010-10-11 06:05:37 +04:00
2006-03-14 04:29:56 +03:00
# endif /* __CREDENTIALS_H__ */