auth.h 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  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. #ifndef _LINUX_SUNRPC_AUTH_H
  9. #define _LINUX_SUNRPC_AUTH_H
  10. #ifdef __KERNEL__
  11. #include <linux/sunrpc/sched.h>
  12. #include <linux/sunrpc/msg_prot.h>
  13. #include <linux/sunrpc/xdr.h>
  14. #include <asm/atomic.h>
  15. /* size of the nodename buffer */
  16. #define UNX_MAXNODENAME 32
  17. /* Work around the lack of a VFS credential */
  18. struct auth_cred {
  19. uid_t uid;
  20. gid_t gid;
  21. struct group_info *group_info;
  22. };
  23. /*
  24. * Client user credentials
  25. */
  26. struct rpc_cred {
  27. struct hlist_node cr_hash; /* hash chain */
  28. struct rpc_credops * cr_ops;
  29. unsigned long cr_expire; /* when to gc */
  30. atomic_t cr_count; /* ref count */
  31. unsigned short cr_flags; /* various flags */
  32. #ifdef RPC_DEBUG
  33. unsigned long cr_magic; /* 0x0f4aa4f0 */
  34. #endif
  35. uid_t cr_uid;
  36. /* per-flavor data */
  37. };
  38. #define RPCAUTH_CRED_NEW 0x0001
  39. #define RPCAUTH_CRED_UPTODATE 0x0002
  40. #define RPCAUTH_CRED_MAGIC 0x0f4aa4f0
  41. /*
  42. * Client authentication handle
  43. */
  44. #define RPC_CREDCACHE_NR 8
  45. #define RPC_CREDCACHE_MASK (RPC_CREDCACHE_NR - 1)
  46. struct rpc_cred_cache {
  47. struct hlist_head hashtable[RPC_CREDCACHE_NR];
  48. unsigned long nextgc; /* next garbage collection */
  49. unsigned long expire; /* cache expiry interval */
  50. };
  51. struct rpc_auth {
  52. unsigned int au_cslack; /* call cred size estimate */
  53. /* guess at number of u32's auth adds before
  54. * reply data; normally the verifier size: */
  55. unsigned int au_rslack;
  56. /* for gss, used to calculate au_rslack: */
  57. unsigned int au_verfsize;
  58. unsigned int au_flags; /* various flags */
  59. struct rpc_authops * au_ops; /* operations */
  60. rpc_authflavor_t au_flavor; /* pseudoflavor (note may
  61. * differ from the flavor in
  62. * au_ops->au_flavor in gss
  63. * case) */
  64. atomic_t au_count; /* Reference counter */
  65. struct rpc_cred_cache * au_credcache;
  66. /* per-flavor data */
  67. };
  68. /* Flags for rpcauth_lookupcred() */
  69. #define RPCAUTH_LOOKUP_NEW 0x01 /* Accept an uninitialised cred */
  70. #define RPCAUTH_LOOKUP_ROOTCREDS 0x02 /* This really ought to go! */
  71. /*
  72. * Client authentication ops
  73. */
  74. struct rpc_authops {
  75. struct module *owner;
  76. rpc_authflavor_t au_flavor; /* flavor (RPC_AUTH_*) */
  77. #ifdef RPC_DEBUG
  78. char * au_name;
  79. #endif
  80. struct rpc_auth * (*create)(struct rpc_clnt *, rpc_authflavor_t);
  81. void (*destroy)(struct rpc_auth *);
  82. struct rpc_cred * (*lookup_cred)(struct rpc_auth *, struct auth_cred *, int);
  83. struct rpc_cred * (*crcreate)(struct rpc_auth*, struct auth_cred *, int);
  84. };
  85. struct rpc_credops {
  86. const char * cr_name; /* Name of the auth flavour */
  87. int (*cr_init)(struct rpc_auth *, struct rpc_cred *);
  88. void (*crdestroy)(struct rpc_cred *);
  89. int (*crmatch)(struct auth_cred *, struct rpc_cred *, int);
  90. __be32 * (*crmarshal)(struct rpc_task *, __be32 *);
  91. int (*crrefresh)(struct rpc_task *);
  92. __be32 * (*crvalidate)(struct rpc_task *, __be32 *);
  93. int (*crwrap_req)(struct rpc_task *, kxdrproc_t,
  94. void *, __be32 *, void *);
  95. int (*crunwrap_resp)(struct rpc_task *, kxdrproc_t,
  96. void *, __be32 *, void *);
  97. };
  98. extern struct rpc_authops authunix_ops;
  99. extern struct rpc_authops authnull_ops;
  100. #ifdef CONFIG_SUNRPC_SECURE
  101. extern struct rpc_authops authdes_ops;
  102. #endif
  103. int rpcauth_register(struct rpc_authops *);
  104. int rpcauth_unregister(struct rpc_authops *);
  105. struct rpc_auth * rpcauth_create(rpc_authflavor_t, struct rpc_clnt *);
  106. void rpcauth_destroy(struct rpc_auth *);
  107. struct rpc_cred * rpcauth_lookup_credcache(struct rpc_auth *, struct auth_cred *, int);
  108. struct rpc_cred * rpcauth_lookupcred(struct rpc_auth *, int);
  109. struct rpc_cred * rpcauth_bindcred(struct rpc_task *);
  110. void rpcauth_holdcred(struct rpc_task *);
  111. void put_rpccred(struct rpc_cred *);
  112. void rpcauth_unbindcred(struct rpc_task *);
  113. __be32 * rpcauth_marshcred(struct rpc_task *, __be32 *);
  114. __be32 * rpcauth_checkverf(struct rpc_task *, __be32 *);
  115. int rpcauth_wrap_req(struct rpc_task *task, kxdrproc_t encode, void *rqstp, __be32 *data, void *obj);
  116. int rpcauth_unwrap_resp(struct rpc_task *task, kxdrproc_t decode, void *rqstp, __be32 *data, void *obj);
  117. int rpcauth_refreshcred(struct rpc_task *);
  118. void rpcauth_invalcred(struct rpc_task *);
  119. int rpcauth_uptodatecred(struct rpc_task *);
  120. int rpcauth_init_credcache(struct rpc_auth *, unsigned long);
  121. void rpcauth_free_credcache(struct rpc_auth *);
  122. static inline
  123. struct rpc_cred * get_rpccred(struct rpc_cred *cred)
  124. {
  125. atomic_inc(&cred->cr_count);
  126. return cred;
  127. }
  128. #endif /* __KERNEL__ */
  129. #endif /* _LINUX_SUNRPC_AUTH_H */