Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
auth.h
Go to the documentation of this file.
1 /*
2  * linux/include/linux/sunrpc/auth.h
3  *
4  * Declarations for the RPC client authentication machinery.
5  *
6  * Copyright (C) 1996, Olaf Kirch <[email protected]>
7  */
8 
9 #ifndef _LINUX_SUNRPC_AUTH_H
10 #define _LINUX_SUNRPC_AUTH_H
11 
12 #ifdef __KERNEL__
13 
14 #include <linux/sunrpc/sched.h>
15 #include <linux/sunrpc/msg_prot.h>
16 #include <linux/sunrpc/xdr.h>
17 
18 #include <linux/atomic.h>
19 #include <linux/rcupdate.h>
20 
21 /* size of the nodename buffer */
22 #define UNX_MAXNODENAME 32
23 
24 /* Work around the lack of a VFS credential */
25 struct auth_cred {
26  uid_t uid;
27  gid_t gid;
28  struct group_info *group_info;
29  const char *principal;
30  unsigned char machine_cred : 1;
31 };
32 
33 /*
34  * Client user credentials
35  */
36 struct rpc_auth;
37 struct rpc_credops;
38 struct rpc_cred {
39  struct hlist_node cr_hash; /* hash chain */
40  struct list_head cr_lru; /* lru garbage collection */
41  struct rcu_head cr_rcu;
42  struct rpc_auth * cr_auth;
43  const struct rpc_credops *cr_ops;
44 #ifdef RPC_DEBUG
45  unsigned long cr_magic; /* 0x0f4aa4f0 */
46 #endif
47  unsigned long cr_expire; /* when to gc */
48  unsigned long cr_flags; /* various flags */
49  atomic_t cr_count; /* ref count */
50 
51  uid_t cr_uid;
52 
53  /* per-flavor data */
54 };
55 #define RPCAUTH_CRED_NEW 0
56 #define RPCAUTH_CRED_UPTODATE 1
57 #define RPCAUTH_CRED_HASHED 2
58 #define RPCAUTH_CRED_NEGATIVE 3
59 
60 #define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
61 
62 /*
63  * Client authentication handle
64  */
65 struct rpc_cred_cache;
66 struct rpc_authops;
67 struct rpc_auth {
68  unsigned int au_cslack; /* call cred size estimate */
69  /* guess at number of u32's auth adds before
70  * reply data; normally the verifier size: */
71  unsigned int au_rslack;
72  /* for gss, used to calculate au_rslack: */
73  unsigned int au_verfsize;
74 
75  unsigned int au_flags; /* various flags */
76  const struct rpc_authops *au_ops; /* operations */
77  rpc_authflavor_t au_flavor; /* pseudoflavor (note may
78  * differ from the flavor in
79  * au_ops->au_flavor in gss
80  * case) */
81  atomic_t au_count; /* Reference counter */
82 
83  struct rpc_cred_cache * au_credcache;
84  /* per-flavor data */
85 };
86 
87 /* Flags for rpcauth_lookupcred() */
88 #define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
89 
90 /*
91  * Client authentication ops
92  */
93 struct rpc_authops {
94  struct module *owner;
95  rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */
96  char * au_name;
97  struct rpc_auth * (*create)(struct rpc_clnt *, rpc_authflavor_t);
98  void (*destroy)(struct rpc_auth *);
99 
100  struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
101  struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int);
102  int (*pipes_create)(struct rpc_auth *);
103  void (*pipes_destroy)(struct rpc_auth *);
104  int (*list_pseudoflavors)(rpc_authflavor_t *, int);
105 };
106 
107 struct rpc_credops {
108  const char * cr_name; /* Name of the auth flavour */
109  int (*cr_init)(struct rpc_auth *, struct rpc_cred *);
110  void (*crdestroy)(struct rpc_cred *);
111 
112  int (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
113  struct rpc_cred * (*crbind)(struct rpc_task *, struct rpc_cred *, int);
114  __be32 * (*crmarshal)(struct rpc_task *, __be32 *);
115  int (*crrefresh)(struct rpc_task *);
116  __be32 * (*crvalidate)(struct rpc_task *, __be32 *);
117  int (*crwrap_req)(struct rpc_task *, kxdreproc_t,
118  void *, __be32 *, void *);
119  int (*crunwrap_resp)(struct rpc_task *, kxdrdproc_t,
120  void *, __be32 *, void *);
121 };
122 
123 extern const struct rpc_authops authunix_ops;
124 extern const struct rpc_authops authnull_ops;
125 
126 int __init rpc_init_authunix(void);
127 int __init rpc_init_generic_auth(void);
128 int __init rpcauth_init_module(void);
129 void rpcauth_remove_module(void);
130 void rpc_destroy_generic_auth(void);
131 void rpc_destroy_authunix(void);
132 
133 struct rpc_cred * rpc_lookup_cred(void);
134 struct rpc_cred * rpc_lookup_machine_cred(const char *service_name);
135 int rpcauth_register(const struct rpc_authops *);
136 int rpcauth_unregister(const struct rpc_authops *);
137 struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
138 void rpcauth_release(struct rpc_auth *);
139 int rpcauth_list_flavors(rpc_authflavor_t *, int);
140 struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
141 void rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *);
142 struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
143 struct rpc_cred * rpcauth_generic_bind_cred(struct rpc_task *, struct rpc_cred *, int);
144 void put_rpccred(struct rpc_cred *);
145 __be32 * rpcauth_marshcred(struct rpc_task *, __be32 *);
146 __be32 * rpcauth_checkverf(struct rpc_task *, __be32 *);
147 int rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp, __be32 *data, void *obj);
148 int rpcauth_unwrap_resp(struct rpc_task *task, kxdrdproc_t decode, void *rqstp, __be32 *data, void *obj);
149 int rpcauth_refreshcred(struct rpc_task *);
150 void rpcauth_invalcred(struct rpc_task *);
151 int rpcauth_uptodatecred(struct rpc_task *);
152 int rpcauth_init_credcache(struct rpc_auth *);
153 void rpcauth_destroy_credcache(struct rpc_auth *);
154 void rpcauth_clear_credcache(struct rpc_cred_cache *);
155 
156 static inline
157 struct rpc_cred * get_rpccred(struct rpc_cred *cred)
158 {
159  atomic_inc(&cred->cr_count);
160  return cred;
161 }
162 
163 #endif /* __KERNEL__ */
164 #endif /* _LINUX_SUNRPC_AUTH_H */
Generated on Thu Jan 10 2013 14:48:49 for Linux Kernel by   doxygen 1.8.2