source/winbindd/winbindd.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Winbind daemon for ntdom nss module
   5
   6    Copyright (C) Tim Potter 2000
   7    Copyright (C) Jim McDonough <jmcd@us.ibm.com> 2003
   8
   9    This library is free software; you can redistribute it and/or
  10    modify it under the terms of the GNU Lesser General Public
  11    License as published by the Free Software Foundation; either
  12    version 3 of the License, or (at your option) any later version.
  13
  14    This library 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 GNU
  17    Library General Public License for more details.
  18
  19    You should have received a copy of the GNU Lesser General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef _WINBINDD_H
  24 #define _WINBINDD_H
  25
  26 #include "nsswitch/winbind_struct_protocol.h"
  27 #include "nsswitch/libwbclient/wbclient.h"
  28
  29 #ifdef HAVE_LIBNSCD
  30 #include <libnscd.h>
  31 #endif
  32
  33 #ifdef HAVE_SYS_MMAN_H
  34 #include <sys/mman.h>
  35 #endif
  36
  37 #undef DBGC_CLASS
  38 #define DBGC_CLASS DBGC_WINBIND
  39
  40 #define WB_REPLACE_CHAR         '_'
  41
  42 /* bits for fd_event.flags */
  43 #define EVENT_FD_READ 1
  44 #define EVENT_FD_WRITE 2
  45
  46 struct fd_event {
  47         struct fd_event *next, *prev;
  48         int fd;
  49         int flags; /* see EVENT_FD_* flags */
  50         void (*handler)(struct fd_event *fde, int flags);
  51         void *data;
  52         size_t length, done;
  53         void (*finished)(void *private_data, bool success);
  54         void *private_data;
  55 };
  56
  57 struct sid_ctr {
  58         DOM_SID *sid;
  59         bool finished;
  60         const char *domain;
  61         const char *name;
  62         enum lsa_SidType type;
  63 };
  64
  65 struct winbindd_cli_state {
  66         struct winbindd_cli_state *prev, *next;   /* Linked list pointers */
  67         int sock;                                 /* Open socket from client */
  68         struct fd_event fd_event;
  69         pid_t pid;                                /* pid of client */
  70         bool finished;                            /* Can delete from list */
  71         bool write_extra_data;                    /* Write extra_data field */
  72         time_t last_access;                       /* Time of last access (read or write) */
  73         bool privileged;                           /* Is the client 'privileged' */
  74
  75         TALLOC_CTX *mem_ctx;                      /* memory per request */
  76         struct winbindd_request request;          /* Request from client */
  77         struct winbindd_response response;        /* Respose to client */
  78         bool getpwent_initialized;                /* Has getpwent_state been
  79                                                    * initialized? */
  80         bool getgrent_initialized;                /* Has getgrent_state been
  81                                                    * initialized? */
  82         struct getent_state *getpwent_state;      /* State for getpwent() */
  83         struct getent_state *getgrent_state;      /* State for getgrent() */
  84 };
  85
  86 /* State between get{pw,gr}ent() calls */
  87
  88 struct getent_state {
  89         struct getent_state *prev, *next;
  90         void *sam_entries;
  91         uint32 sam_entry_index, num_sam_entries;
  92         bool got_sam_entries;
  93         fstring domain_name;
  94 };
  95
  96 /* Storage for cached getpwent() user entries */
  97
  98 struct getpwent_user {
  99         fstring name;                        /* Account name */
 100         fstring gecos;                       /* User information */
 101         fstring homedir;                     /* User Home Directory */
 102         fstring shell;                       /* User Login Shell */
 103         DOM_SID user_sid;                    /* NT user and primary group SIDs */
 104         DOM_SID group_sid;
 105 };
 106
 107 /* Server state structure */
 108
 109 typedef struct {
 110         char *acct_name;
 111         char *full_name;
 112         char *homedir;
 113         char *shell;
 114         gid_t primary_gid;                   /* allow the nss_info
 115                                                 backend to set the primary group */
 116         DOM_SID user_sid;                    /* NT user and primary group SIDs */
 117         DOM_SID group_sid;
 118 } WINBIND_USERINFO;
 119
 120 /* Our connection to the DC */
 121
 122 struct winbindd_cm_conn {
 123         struct cli_state *cli;
 124
 125         struct rpc_pipe_client *samr_pipe;
 126         POLICY_HND sam_connect_handle, sam_domain_handle;
 127
 128         struct rpc_pipe_client *lsa_pipe;
 129         POLICY_HND lsa_policy;
 130
 131         struct rpc_pipe_client *netlogon_pipe;
 132 };
 133
 134 struct winbindd_async_request;
 135
 136 /* Async child */
 137
 138 struct winbindd_domain;
 139
 140 struct winbindd_child_dispatch_table {
 141         const char *name;
 142         enum winbindd_cmd struct_cmd;
 143         enum winbindd_result (*struct_fn)(struct winbindd_domain *domain,
 144                                           struct winbindd_cli_state *state);
 145 };
 146
 147 struct winbindd_child {
 148         struct winbindd_child *next, *prev;
 149
 150         pid_t pid;
 151         struct winbindd_domain *domain;
 152         char *logfilename;
 153
 154         struct fd_event event;
 155         struct timed_event *lockout_policy_event;
 156         struct winbindd_async_request *requests;
 157
 158         const struct winbindd_child_dispatch_table *table;
 159 };
 160
 161 /* Structures to hold per domain information */
 162
 163 struct winbindd_domain {
 164         fstring name;                          /* Domain name (NetBIOS) */
 165         fstring alt_name;                      /* alt Domain name, if any (FQDN for ADS) */
 166         fstring forest_name;                   /* Name of the AD forest we're in */
 167         DOM_SID sid;                           /* SID for this domain */
 168         uint32 domain_flags;                   /* Domain flags from netlogon.h */
 169         uint32 domain_type;                    /* Domain type from netlogon.h */
 170         uint32 domain_trust_attribs;           /* Trust attribs from netlogon.h */
 171         bool initialized;                      /* Did we already ask for the domain mode? */
 172         bool native_mode;                      /* is this a win2k domain in native mode ? */
 173         bool active_directory;                 /* is this a win2k active directory ? */
 174         bool primary;                          /* is this our primary domain ? */
 175         bool internal;                         /* BUILTIN and member SAM */
 176         bool online;                           /* is this domain available ? */
 177         time_t startup_time;                   /* When we set "startup" true. */
 178         bool startup;                          /* are we in the first 30 seconds after startup_time ? */
 179
 180         bool can_do_samlogon_ex; /* Due to the lack of finer control what type
 181                                   * of DC we have, let us try to do a
 182                                   * credential-chain less samlogon_ex call
 183                                   * with AD and schannel. If this fails with
 184                                   * DCERPC_FAULT_OP_RNG_ERROR, then set this
 185                                   * to False. This variable is around so that
 186                                   * we don't have to try _ex every time. */
 187
 188         /* Lookup methods for this domain (LDAP or RPC) */
 189         struct winbindd_methods *methods;
 190
 191         /* the backend methods are used by the cache layer to find the right
 192            backend */
 193         struct winbindd_methods *backend;
 194
 195         /* Private data for the backends (used for connection cache) */
 196
 197         void *private_data;
 198
 199         /* A working DC */
 200         fstring dcname;
 201         struct sockaddr_storage dcaddr;
 202
 203         /* Sequence number stuff */
 204
 205         time_t last_seq_check;
 206         uint32 sequence_number;
 207         NTSTATUS last_status;
 208
 209         /* The smb connection */
 210
 211         struct winbindd_cm_conn conn;
 212
 213         /* The child pid we're talking to */
 214
 215         struct winbindd_child child;
 216
 217         /* Callback we use to try put us back online. */
 218
 219         uint32 check_online_timeout;
 220         struct timed_event *check_online_event;
 221
 222         /* Linked list info */
 223
 224         struct winbindd_domain *prev, *next;
 225 };
 226
 227 /* per-domain methods. This is how LDAP vs RPC is selected
 228  */
 229 struct winbindd_methods {
 230         /* does this backend provide a consistent view of the data? (ie. is the primary group
 231            always correct) */
 232         bool consistent;
 233
 234         /* get a list of users, returning a WINBIND_USERINFO for each one */
 235         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
 236                                    TALLOC_CTX *mem_ctx,
 237                                    uint32 *num_entries,
 238                                    WINBIND_USERINFO **info);
 239
 240         /* get a list of domain groups */
 241         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
 242                                     TALLOC_CTX *mem_ctx,
 243                                     uint32 *num_entries,
 244                                     struct acct_info **info);
 245
 246         /* get a list of domain local groups */
 247         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
 248                                     TALLOC_CTX *mem_ctx,
 249                                     uint32 *num_entries,
 250                                     struct acct_info **info);
 251
 252         /* convert one user or group name to a sid */
 253         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
 254                                 TALLOC_CTX *mem_ctx,
 255                                 enum winbindd_cmd orig_cmd,
 256                                 const char *domain_name,
 257                                 const char *name,
 258                                 DOM_SID *sid,
 259                                 enum lsa_SidType *type);
 260
 261         /* convert a sid to a user or group name */
 262         NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
 263                                 TALLOC_CTX *mem_ctx,
 264                                 const DOM_SID *sid,
 265                                 char **domain_name,
 266                                 char **name,
 267                                 enum lsa_SidType *type);
 268
 269         NTSTATUS (*rids_to_names)(struct winbindd_domain *domain,
 270                                   TALLOC_CTX *mem_ctx,
 271                                   const DOM_SID *domain_sid,
 272                                   uint32 *rids,
 273                                   size_t num_rids,
 274                                   char **domain_name,
 275                                   char ***names,
 276                                   enum lsa_SidType **types);
 277
 278         /* lookup user info for a given SID */
 279         NTSTATUS (*query_user)(struct winbindd_domain *domain,
 280                                TALLOC_CTX *mem_ctx,
 281                                const DOM_SID *user_sid,
 282                                WINBIND_USERINFO *user_info);
 283
 284         /* lookup all groups that a user is a member of. The backend
 285            can also choose to lookup by username or rid for this
 286            function */
 287         NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
 288                                       TALLOC_CTX *mem_ctx,
 289                                       const DOM_SID *user_sid,
 290                                       uint32 *num_groups, DOM_SID **user_gids);
 291
 292         /* Lookup all aliases that the sids delivered are member of. This is
 293          * to implement 'domain local groups' correctly */
 294         NTSTATUS (*lookup_useraliases)(struct winbindd_domain *domain,
 295                                        TALLOC_CTX *mem_ctx,
 296                                        uint32 num_sids,
 297                                        const DOM_SID *sids,
 298                                        uint32 *num_aliases,
 299                                        uint32 **alias_rids);
 300
 301         /* find all members of the group with the specified group_rid */
 302         NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
 303                                     TALLOC_CTX *mem_ctx,
 304                                     const DOM_SID *group_sid,
 305                                     uint32 *num_names,
 306                                     DOM_SID **sid_mem, char ***names,
 307                                     uint32 **name_types);
 308
 309         /* return the current global sequence number */
 310         NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32 *seq);
 311
 312         /* return the lockout policy */
 313         NTSTATUS (*lockout_policy)(struct winbindd_domain *domain,
 314                                    TALLOC_CTX *mem_ctx,
 315                                    struct samr_DomInfo12 *lockout_policy);
 316
 317         /* return the lockout policy */
 318         NTSTATUS (*password_policy)(struct winbindd_domain *domain,
 319                                     TALLOC_CTX *mem_ctx,
 320                                     struct samr_DomInfo1 *password_policy);
 321
 322         /* enumerate trusted domains */
 323         NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
 324                                     TALLOC_CTX *mem_ctx,
 325                                     uint32 *num_domains,
 326                                     char ***names,
 327                                     char ***alt_names,
 328                                     DOM_SID **dom_sids);
 329 };
 330
 331 /* Used to glue a policy handle and cli_state together */
 332
 333 typedef struct {
 334         struct cli_state *cli;
 335         POLICY_HND pol;
 336 } CLI_POLICY_HND;
 337
 338 /* Filled out by IDMAP backends */
 339 struct winbindd_idmap_methods {
 340   /* Called when backend is first loaded */
 341   bool (*init)(void);
 342
 343   bool (*get_sid_from_uid)(uid_t uid, DOM_SID *sid);
 344   bool (*get_sid_from_gid)(gid_t gid, DOM_SID *sid);
 345
 346   bool (*get_uid_from_sid)(DOM_SID *sid, uid_t *uid);
 347   bool (*get_gid_from_sid)(DOM_SID *sid, gid_t *gid);
 348
 349   /* Called when backend is unloaded */
 350   bool (*close)(void);
 351   /* Called to dump backend status */
 352   void (*status)(void);
 353 };
 354
 355 /* Data structures for dealing with the trusted domain cache */
 356
 357 struct winbindd_tdc_domain {
 358         const char *domain_name;
 359         const char *dns_name;
 360         DOM_SID sid;
 361         uint32 trust_flags;
 362         uint32 trust_attribs;
 363         uint32 trust_type;
 364 };
 365
 366 /* Switch for listing users or groups */
 367 enum ent_type {
 368         LIST_USERS = 0,
 369         LIST_GROUPS,
 370 };
 371
 372 #include "winbindd/winbindd_proto.h"
 373
 374 #define WINBINDD_ESTABLISH_LOOP 30
 375 #define WINBINDD_RESCAN_FREQ lp_winbind_cache_time()
 376 #define WINBINDD_PAM_AUTH_KRB5_RENEW_TIME 2592000 /* one month */
 377 #define DOM_SEQUENCE_NONE ((uint32)-1)
 378
 379 #define IS_DOMAIN_OFFLINE(x) ( lp_winbind_offline_logon() && \
 380                                ( get_global_winbindd_state_offline() \
 381                                  || !(x)->online ) )
 382 #define IS_DOMAIN_ONLINE(x) (!IS_DOMAIN_OFFLINE(x))
 383
 384 #endif /* _WINBINDD_H */