ldap_common.h revision 3d29430867cf92b2d71afa95abb679711231117c
/*
SSSD
LDAP Common utility code
Copyright (C) Simo Sorce <ssorce@redhat.com> 2009
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
the Free Software Foundation; either version 3 of the License, or
(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
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _LDAP_COMMON_H_
#define _LDAP_COMMON_H_
#include "providers/backend.h"
#include "providers/ldap/sdap.h"
#include "providers/ldap/sdap_id_op.h"
#include "providers/fail_over.h"
#include "providers/krb5/krb5_common.h"
#include "lib/idmap/sss_idmap.h"
#define PWD_POL_OPT_NONE "none"
#define PWD_POL_OPT_SHADOW "shadow"
#define PWD_POL_OPT_MIT "mit_kerberos"
#define SSS_LDAP_SRV_NAME "ldap"
#define LDAP_STANDARD_URI "ldap://"
#define LDAP_SSL_URI "ldaps://"
#define LDAP_LDAPI_URI "ldapi://"
/* Only the asterisk is allowed in wildcard requests */
#define LDAP_ALLOWED_WILDCARDS "*"
/* a fd the child process would log into */
extern int ldap_child_debug_fd;
struct sdap_id_ctx;
struct sdap_id_conn_ctx {
struct sdap_id_ctx *id_ctx;
struct sdap_service *service;
/* LDAP connection cache */
struct sdap_id_conn_cache *conn_cache;
/* dlinklist pointers */
struct sdap_id_conn_ctx *prev, *next;
/* do not go offline, try another connection */
bool ignore_mark_offline;
};
struct sdap_id_ctx {
struct be_ctx *be;
struct sdap_options *opts;
/* If using GSSAPI */
struct krb5_service *krb5_service;
/* connection to a server */
struct sdap_id_conn_ctx *conn;
struct sdap_server_opts *srv_opts;
};
struct sdap_auth_ctx {
struct be_ctx *be;
struct sdap_options *opts;
struct sdap_service *service;
struct sdap_service *chpass_service;
};
struct tevent_req *
sdap_online_check_handler_send(TALLOC_CTX *mem_ctx,
struct sdap_id_ctx *id_ctx,
void *data,
struct dp_req_params *params);
errno_t sdap_online_check_handler_recv(TALLOC_CTX *mem_ctx,
struct tevent_req *req,
struct dp_reply_std *data);
struct tevent_req* sdap_reinit_cleanup_send(TALLOC_CTX *mem_ctx,
struct be_ctx *be_ctx,
struct sdap_id_ctx *id_ctx);
errno_t sdap_reinit_cleanup_recv(struct tevent_req *req);
/* id */
struct tevent_req *
sdap_account_info_handler_send(TALLOC_CTX *mem_ctx,
struct sdap_id_ctx *id_ctx,
struct dp_id_data *data,
struct dp_req_params *params);
errno_t sdap_account_info_handler_recv(TALLOC_CTX *mem_ctx,
struct tevent_req *req,
struct dp_reply_std *data);
/* Set up enumeration and/or cleanup */
int ldap_id_setup_tasks(struct sdap_id_ctx *ctx);
int sdap_id_setup_tasks(struct be_ctx *be_ctx,
struct sdap_id_ctx *ctx,
struct sdap_domain *sdom,
be_ptask_send_t send_fn,
be_ptask_recv_t recv_fn,
void *pvt);
/* Allow shortcutting an enumeration request */
bool sdap_is_enum_request(struct dp_id_data *ar);
struct tevent_req *
sdap_handle_acct_req_send(TALLOC_CTX *mem_ctx,
struct be_ctx *be_ctx,
struct dp_id_data *ar,
struct sdap_id_ctx *id_ctx,
struct sdap_domain *sdom,
struct sdap_id_conn_ctx *conn,
bool noexist_delete);
errno_t
sdap_handle_acct_req_recv(struct tevent_req *req,
int *_dp_error, const char **_err,
int *sdap_ret);
struct tevent_req *
sdap_pam_auth_handler_send(TALLOC_CTX *mem_ctx,
struct sdap_auth_ctx *auth_ctx,
struct pam_data *pd,
struct dp_req_params *params);
errno_t
sdap_pam_auth_handler_recv(TALLOC_CTX *mem_ctx,
struct tevent_req *req,
struct pam_data **_data);
struct tevent_req *
sdap_pam_chpass_handler_send(TALLOC_CTX *mem_ctx,
struct sdap_auth_ctx *auth_ctx,
struct pam_data *pd,
struct dp_req_params *params);
errno_t
sdap_pam_chpass_handler_recv(TALLOC_CTX *mem_ctx,
struct tevent_req *req,
struct pam_data **_data);
/* autofs */
struct tevent_req *
sdap_autofs_handler_send(TALLOC_CTX *mem_ctx,
struct sdap_id_ctx *id_ctx,
struct dp_autofs_data *data,
struct dp_req_params *params);
errno_t
sdap_autofs_handler_recv(TALLOC_CTX *mem_ctx,
struct tevent_req *req,
struct dp_reply_std *data);
int sdap_service_init(TALLOC_CTX *memctx, struct be_ctx *ctx,
const char *service_name, const char *dns_service_name,
const char *urls, const char *backup_urls,
struct sdap_service **_service);
const char *sdap_gssapi_realm(struct dp_option *opts);
int sdap_gssapi_init(TALLOC_CTX *mem_ctx,
struct dp_option *opts,
struct be_ctx *bectx,
struct sdap_service *sdap_service,
struct krb5_service **krb5_service);
errno_t sdap_install_offline_callback(TALLOC_CTX *mem_ctx,
struct be_ctx *be_ctx,
const char *realm,
const char *service_name);
errno_t sdap_install_sigterm_handler(TALLOC_CTX *mem_ctx,
struct tevent_context *ev,
const char *realm);
void sdap_remove_kdcinfo_files_callback(void *pvt);
/* options parser */
int ldap_get_options(TALLOC_CTX *memctx,
struct sss_domain_info *dom,
struct confdb_ctx *cdb,
const char *conf_path,
struct sdap_options **_opts);
int ldap_get_sudo_options(struct confdb_ctx *cdb,
const char *conf_path,
struct sdap_options *opts,
bool *use_host_filter,
bool *include_regexp,
bool *include_netgroups);
int ldap_get_autofs_options(TALLOC_CTX *memctx,
struct confdb_ctx *cdb,
const char *conf_path,
struct sdap_options *opts);
/* Calling ldap_setup_enumeration will set up a periodic task
* that would periodically call send_fn/recv_fn request. The
* send_fn's pvt parameter will be a pointer to ldap_enum_ctx
* structure that contains the request data
*/
struct ldap_enum_ctx {
struct sdap_domain *sdom;
void *pvt;
};
errno_t ldap_setup_enumeration(struct be_ctx *be_ctx,
struct sdap_options *opts,
struct sdap_domain *sdom,
be_ptask_send_t send_fn,
be_ptask_recv_t recv_fn,
void *pvt);
struct tevent_req *
ldap_enumeration_send(TALLOC_CTX *mem_ctx,
struct tevent_context *ev,
struct be_ctx *be_ctx,
struct be_ptask *be_ptask,
void *pvt);
errno_t ldap_enumeration_recv(struct tevent_req *req);
errno_t ldap_setup_cleanup(struct sdap_id_ctx *id_ctx,
struct sdap_domain *sdom);
errno_t ldap_id_cleanup(struct sdap_options *opts,
struct sdap_domain *sdom);
struct tevent_req *groups_get_send(TALLOC_CTX *memctx,
struct tevent_context *ev,
struct sdap_id_ctx *ctx,
struct sdap_domain *sdom,
struct sdap_id_conn_ctx *conn,
const char *name,
int filter_type,
int attrs_type,
bool noexist_delete,
bool no_members);
int groups_get_recv(struct tevent_req *req, int *dp_error_out, int *sdap_ret);
struct tevent_req *ldap_netgroup_get_send(TALLOC_CTX *memctx,
struct tevent_context *ev,
struct sdap_id_ctx *ctx,
struct sdap_domain *sdom,
struct sdap_id_conn_ctx *conn,
const char *name,
bool noexist_delete);
int ldap_netgroup_get_recv(struct tevent_req *req, int *dp_error_out, int *sdap_ret);
struct tevent_req *
services_get_send(TALLOC_CTX *mem_ctx,
struct tevent_context *ev,
struct sdap_id_ctx *id_ctx,
struct sdap_domain *sdom,
struct sdap_id_conn_ctx *conn,
const char *name,
const char *protocol,
int filter_type,
bool noexist_delete);
errno_t
services_get_recv(struct tevent_req *req, int *dp_error_out, int *sdap_ret);
/* setup child logging */
int sdap_setup_child(void);
errno_t string_to_shadowpw_days(const char *s, long *d);
errno_t get_sysdb_attr_name(TALLOC_CTX *mem_ctx,
struct sdap_attr_map *map,
size_t map_size,
const char *ldap_name,
char **sysdb_name);
errno_t list_missing_attrs(TALLOC_CTX *mem_ctx,
struct sdap_attr_map *map,
size_t map_size,
struct sysdb_attrs *recvd_attrs,
char ***missing_attrs);
bool sdap_is_secure_uri(const char *uri);
char *sdap_or_filters(TALLOC_CTX *mem_ctx,
const char *base_filter,
const char *extra_filter);
char *sdap_combine_filters(TALLOC_CTX *mem_ctx,
const char *base_filter,
const char *extra_filter);
char *sdap_get_access_filter(TALLOC_CTX *mem_ctx,
const char *base_filter);
errno_t msgs2attrs_array(TALLOC_CTX *mem_ctx, size_t count,
struct ldb_message **msgs,
struct sysdb_attrs ***attrs);
errno_t sdap_domain_add(struct sdap_options *opts,
struct sss_domain_info *dom,
struct sdap_domain **_sdom);
errno_t
sdap_domain_subdom_add(struct sdap_id_ctx *sdap_id_ctx,
struct sdap_domain *sdom_list,
struct sss_domain_info *parent);
void
sdap_domain_remove(struct sdap_options *opts,
struct sss_domain_info *dom);
struct sdap_domain *sdap_domain_get(struct sdap_options *opts,
struct sss_domain_info *dom);
struct sdap_domain *sdap_domain_get_by_dn(struct sdap_options *opts,
const char *dn);
errno_t sdap_parse_search_base(TALLOC_CTX *mem_ctx,
struct dp_option *opts, int class,
struct sdap_search_base ***_search_bases);
errno_t common_parse_search_base(TALLOC_CTX *mem_ctx,
const char *unparsed_base,
const char *class_name,
const char *old_filter,
struct sdap_search_base ***_search_bases);
errno_t
sdap_attrs_get_sid_str(TALLOC_CTX *mem_ctx,
struct sdap_idmap_ctx *idmap_ctx,
struct sysdb_attrs *sysdb_attrs,
const char *sid_attr,
char **_sid_str);
errno_t
sdap_set_sasl_options(struct sdap_options *id_opts,
char *default_primary,
char *default_realm,
const char *keytab_path);
struct sdap_id_conn_ctx *
sdap_id_ctx_conn_add(struct sdap_id_ctx *id_ctx,
struct sdap_service *sdap_service);
struct sdap_id_ctx *
sdap_id_ctx_new(TALLOC_CTX *mem_ctx, struct be_ctx *bectx,
struct sdap_service *sdap_service);
errno_t sdap_refresh_init(struct be_refresh_ctx *refresh_ctx,
struct sdap_id_ctx *id_ctx);
#endif /* _LDAP_COMMON_H_ */