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