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