Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * linux/include/linux/sunrpc/auth.h
3 *
4 * Declarations for the RPC client authentication machinery.
5 *
6 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
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 */
25struct auth_cred {
26 uid_t uid;
27 gid_t gid;
28 struct group_info *group_info;
29 unsigned char machine_cred : 1;
30};
31
32/*
33 * Client user credentials
34 */
35struct rpc_auth;
36struct rpc_credops;
37struct rpc_cred {
38 struct hlist_node cr_hash; /* hash chain */
39 struct list_head cr_lru; /* lru garbage collection */
40 struct rcu_head cr_rcu;
41 struct rpc_auth * cr_auth;
42 const struct rpc_credops *cr_ops;
43#ifdef RPC_DEBUG
44 unsigned long cr_magic; /* 0x0f4aa4f0 */
45#endif
46 unsigned long cr_expire; /* when to gc */
47 unsigned long cr_flags; /* various flags */
48 atomic_t cr_count; /* ref count */
49
50 uid_t cr_uid;
51
52 /* per-flavor data */
53};
54#define RPCAUTH_CRED_NEW 0
55#define RPCAUTH_CRED_UPTODATE 1
56#define RPCAUTH_CRED_HASHED 2
57#define RPCAUTH_CRED_NEGATIVE 3
58
59#define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
60
61/*
62 * Client authentication handle
63 */
64struct rpc_cred_cache;
65struct rpc_authops;
66struct rpc_auth {
67 unsigned int au_cslack; /* call cred size estimate */
68 /* guess at number of u32's auth adds before
69 * reply data; normally the verifier size: */
70 unsigned int au_rslack;
71 /* for gss, used to calculate au_rslack: */
72 unsigned int au_verfsize;
73
74 unsigned int au_flags; /* various flags */
75 const struct rpc_authops *au_ops; /* operations */
76 rpc_authflavor_t au_flavor; /* pseudoflavor (note may
77 * differ from the flavor in
78 * au_ops->au_flavor in gss
79 * case) */
80 atomic_t au_count; /* Reference counter */
81
82 struct rpc_cred_cache * au_credcache;
83 /* per-flavor data */
84};
85
86/* Flags for rpcauth_lookupcred() */
87#define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
88
89/*
90 * Client authentication ops
91 */
92struct rpc_authops {
93 struct module *owner;
94 rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */
95 char * au_name;
96 struct rpc_auth * (*create)(struct rpc_clnt *, rpc_authflavor_t);
97 void (*destroy)(struct rpc_auth *);
98
99 struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
100 struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int);
101};
102
103struct rpc_credops {
104 const char * cr_name; /* Name of the auth flavour */
105 int (*cr_init)(struct rpc_auth *, struct rpc_cred *);
106 void (*crdestroy)(struct rpc_cred *);
107
108 int (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
109 struct rpc_cred * (*crbind)(struct rpc_task *, struct rpc_cred *, int);
110 __be32 * (*crmarshal)(struct rpc_task *, __be32 *);
111 int (*crrefresh)(struct rpc_task *);
112 __be32 * (*crvalidate)(struct rpc_task *, __be32 *);
113 int (*crwrap_req)(struct rpc_task *, kxdreproc_t,
114 void *, __be32 *, void *);
115 int (*crunwrap_resp)(struct rpc_task *, kxdrdproc_t,
116 void *, __be32 *, void *);
117};
118
119extern const struct rpc_authops authunix_ops;
120extern const struct rpc_authops authnull_ops;
121
122int __init rpc_init_authunix(void);
123int __init rpc_init_generic_auth(void);
124int __init rpcauth_init_module(void);
125void rpcauth_remove_module(void);
126void rpc_destroy_generic_auth(void);
127void rpc_destroy_authunix(void);
128
129struct rpc_cred * rpc_lookup_cred(void);
130struct rpc_cred * rpc_lookup_machine_cred(void);
131int rpcauth_register(const struct rpc_authops *);
132int rpcauth_unregister(const struct rpc_authops *);
133struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
134void rpcauth_release(struct rpc_auth *);
135struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
136void rpcauth_init_cred(struct rpc_cred *, const struct auth_cred *, struct rpc_auth *, const struct rpc_credops *);
137struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
138struct rpc_cred * rpcauth_generic_bind_cred(struct rpc_task *, struct rpc_cred *, int);
139void put_rpccred(struct rpc_cred *);
140__be32 * rpcauth_marshcred(struct rpc_task *, __be32 *);
141__be32 * rpcauth_checkverf(struct rpc_task *, __be32 *);
142int rpcauth_wrap_req(struct rpc_task *task, kxdreproc_t encode, void *rqstp, __be32 *data, void *obj);
143int rpcauth_unwrap_resp(struct rpc_task *task, kxdrdproc_t decode, void *rqstp, __be32 *data, void *obj);
144int rpcauth_refreshcred(struct rpc_task *);
145void rpcauth_invalcred(struct rpc_task *);
146int rpcauth_uptodatecred(struct rpc_task *);
147int rpcauth_init_credcache(struct rpc_auth *);
148void rpcauth_destroy_credcache(struct rpc_auth *);
149void rpcauth_clear_credcache(struct rpc_cred_cache *);
150
151static inline
152struct rpc_cred * get_rpccred(struct rpc_cred *cred)
153{
154 atomic_inc(&cred->cr_count);
155 return cred;
156}
157
158#endif /* __KERNEL__ */
159#endif /* _LINUX_SUNRPC_AUTH_H */