source/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 #undef DBGC_CLASS
  33 #define DBGC_CLASS DBGC_WINBIND
  34
  35 /* Client state structure */
  36
  37 struct winbindd_cli_state {
  38         struct winbindd_cli_state *prev, *next;   /* Linked list pointers */
  39         int sock;                                 /* Open socket from client */
  40         pid_t pid;                                /* pid of client */
  41         int read_buf_len, write_buf_len;          /* Indexes in request/response */
  42         BOOL finished;                            /* Can delete from list */
  43         BOOL write_extra_data;                    /* Write extra_data field */
  44         time_t last_access;                       /* Time of last access (read or write) */
  45         BOOL privileged;                           /* Is the client 'privileged' */
  46
  47         struct winbindd_request request;          /* Request from client */
  48         struct winbindd_response response;        /* Respose to client */
  49         struct getent_state *getpwent_state;      /* State for getpwent() */
  50         struct getent_state *getgrent_state;      /* State for getgrent() */
  51 };
  52
  53 /* State between get{pw,gr}ent() calls */
  54
  55 struct getent_state {
  56         struct getent_state *prev, *next;
  57         void *sam_entries;
  58         uint32 sam_entry_index, num_sam_entries;
  59         BOOL got_sam_entries;
  60         fstring domain_name;
  61 };
  62
  63 /* Storage for cached getpwent() user entries */
  64
  65 struct getpwent_user {
  66         fstring name;                        /* Account name */
  67         fstring gecos;                       /* User information */
  68         DOM_SID user_sid;                    /* NT user and primary group SIDs */
  69         DOM_SID group_sid;
  70 };
  71
  72 /* Server state structure */
  73
  74 struct winbindd_state {
  75
  76         /* User and group id pool */
  77
  78         uid_t uid_low, uid_high;               /* Range of uids to allocate */
  79         gid_t gid_low, gid_high;               /* Range of gids to allocate */
  80 };
  81
  82 extern struct winbindd_state server_state;  /* Server information */
  83
  84 typedef struct {
  85         char *acct_name;
  86         char *full_name;
  87         DOM_SID *user_sid;                    /* NT user and primary group SIDs */
  88         DOM_SID *group_sid;
  89 } WINBIND_USERINFO;
  90
  91 /* Structures to hold per domain information */
  92
  93 struct winbindd_domain {
  94         fstring name;                          /* Domain name */
  95         fstring alt_name;                      /* alt Domain name (if any) */
  96         DOM_SID sid;                           /* SID for this domain */
  97         BOOL native_mode;                      /* is this a win2k domain in native mode ? */
  98         BOOL active_directory;                 /* is this a win2k active directory ? */
  99         BOOL primary;                          /* is this our primary domain ? */
 100
 101         /* Lookup methods for this domain (LDAP or RPC) */
 102         struct winbindd_methods *methods;
 103
 104         /* the backend methods are used by the cache layer to find the right
 105            backend */
 106         struct winbindd_methods *backend;
 107
 108         /* Private data for the backends (used for connection cache) */
 109
 110         void *private;
 111
 112         /* Sequence number stuff */
 113
 114         time_t last_seq_check;
 115         uint32 sequence_number;
 116         NTSTATUS last_status;
 117
 118         /* Linked list info */
 119
 120         struct winbindd_domain *prev, *next;
 121 };
 122
 123 /* per-domain methods. This is how LDAP vs RPC is selected
 124  */
 125 struct winbindd_methods {
 126         /* does this backend provide a consistent view of the data? (ie. is the primary group
 127            always correct) */
 128         BOOL consistent;
 129
 130         /* get a list of users, returning a WINBIND_USERINFO for each one */
 131         NTSTATUS (*query_user_list)(struct winbindd_domain *domain,
 132                                    TALLOC_CTX *mem_ctx,
 133                                    uint32 *num_entries,
 134                                    WINBIND_USERINFO **info);
 135
 136         /* get a list of domain groups */
 137         NTSTATUS (*enum_dom_groups)(struct winbindd_domain *domain,
 138                                     TALLOC_CTX *mem_ctx,
 139                                     uint32 *num_entries,
 140                                     struct acct_info **info);
 141
 142         /* get a list of domain local groups */
 143         NTSTATUS (*enum_local_groups)(struct winbindd_domain *domain,
 144                                     TALLOC_CTX *mem_ctx,
 145                                     uint32 *num_entries,
 146                                     struct acct_info **info);
 147
 148         /* convert one user or group name to a sid */
 149         NTSTATUS (*name_to_sid)(struct winbindd_domain *domain,
 150                                 TALLOC_CTX *mem_ctx,
 151                                 const char *name,
 152                                 DOM_SID *sid,
 153                                 enum SID_NAME_USE *type);
 154
 155         /* convert a sid to a user or group name */
 156         NTSTATUS (*sid_to_name)(struct winbindd_domain *domain,
 157                                 TALLOC_CTX *mem_ctx,
 158                                 const DOM_SID *sid,
 159                                 char **name,
 160                                 enum SID_NAME_USE *type);
 161
 162         /* lookup user info for a given SID */
 163         NTSTATUS (*query_user)(struct winbindd_domain *domain,
 164                                TALLOC_CTX *mem_ctx,
 165                                DOM_SID *user_sid,
 166                                WINBIND_USERINFO *user_info);
 167
 168         /* lookup all groups that a user is a member of. The backend
 169            can also choose to lookup by username or rid for this
 170            function */
 171         NTSTATUS (*lookup_usergroups)(struct winbindd_domain *domain,
 172                                       TALLOC_CTX *mem_ctx,
 173                                       DOM_SID *user_sid,
 174                                       uint32 *num_groups, DOM_SID ***user_gids);
 175
 176         /* find all members of the group with the specified group_rid */
 177         NTSTATUS (*lookup_groupmem)(struct winbindd_domain *domain,
 178                                     TALLOC_CTX *mem_ctx,
 179                                     DOM_SID *group_sid,
 180                                     uint32 *num_names,
 181                                     DOM_SID ***sid_mem, char ***names,
 182                                     uint32 **name_types);
 183
 184         /* return the current global sequence number */
 185         NTSTATUS (*sequence_number)(struct winbindd_domain *domain, uint32 *seq);
 186
 187         /* enumerate trusted domains */
 188         NTSTATUS (*trusted_domains)(struct winbindd_domain *domain,
 189                                     TALLOC_CTX *mem_ctx,
 190                                     uint32 *num_domains,
 191                                     char ***names,
 192                                     char ***alt_names,
 193                                     DOM_SID **dom_sids);
 194
 195         /* find the domain sid */
 196         NTSTATUS (*domain_sid)(struct winbindd_domain *domain,
 197                                DOM_SID *sid);
 198
 199         /* setup the list of alternate names for the domain, if any */
 200         NTSTATUS (*alternate_name)(struct winbindd_domain *domain);
 201 };
 202
 203 /* Used to glue a policy handle and cli_state together */
 204
 205 typedef struct {
 206         struct cli_state *cli;
 207         POLICY_HND pol;
 208 } CLI_POLICY_HND;
 209
 210 /* Filled out by IDMAP backends */
 211 struct winbindd_idmap_methods {
 212   /* Called when backend is first loaded */
 213   BOOL (*init)(void);
 214
 215   BOOL (*get_sid_from_uid)(uid_t uid, DOM_SID *sid);
 216   BOOL (*get_sid_from_gid)(gid_t gid, DOM_SID *sid);
 217
 218   BOOL (*get_uid_from_sid)(DOM_SID *sid, uid_t *uid);
 219   BOOL (*get_gid_from_sid)(DOM_SID *sid, gid_t *gid);
 220
 221   /* Called when backend is unloaded */
 222   BOOL (*close)(void);
 223   /* Called to dump backend status */
 224   void (*status)(void);
 225 };
 226
 227 #include "../nsswitch/winbindd_proto.h"
 228
 229 #include "rpc_parse.h"
 230 #include "rpc_client.h"
 231
 232 #define WINBINDD_ESTABLISH_LOOP 30
 233 #define WINBINDD_RESCAN_FREQ 300
 234
 235 #define DOM_SEQUENCE_NONE ((uint32)-1)
 236
 237 #endif /* _WINBINDD_H */