1 #ifndef _FS_CEPH_AUTH_H
2 #define _FS_CEPH_AUTH_H
3 
4 #include <linux/ceph/types.h>
5 #include <linux/ceph/buffer.h>
6 
7 /*
8  * Abstract interface for communicating with the authenticate module.
9  * There is some handshake that takes place between us and the monitor
10  * to acquire the necessary keys.  These are used to generate an
11  * 'authorizer' that we use when connecting to a service (mds, osd).
12  */
13 
14 struct ceph_auth_client;
15 struct ceph_authorizer;
16 
17 struct ceph_auth_handshake {
18 	struct ceph_authorizer *authorizer;
19 	void *authorizer_buf;
20 	size_t authorizer_buf_len;
21 	void *authorizer_reply_buf;
22 	size_t authorizer_reply_buf_len;
23 };
24 
25 struct ceph_auth_client_ops {
26 	const char *name;
27 
28 	/*
29 	 * true if we are authenticated and can connect to
30 	 * services.
31 	 */
32 	int (*is_authenticated)(struct ceph_auth_client *ac);
33 
34 	/*
35 	 * true if we should (re)authenticate, e.g., when our tickets
36 	 * are getting old and crusty.
37 	 */
38 	int (*should_authenticate)(struct ceph_auth_client *ac);
39 
40 	/*
41 	 * build requests and process replies during monitor
42 	 * handshake.  if handle_reply returns -EAGAIN, we build
43 	 * another request.
44 	 */
45 	int (*build_request)(struct ceph_auth_client *ac, void *buf, void *end);
46 	int (*handle_reply)(struct ceph_auth_client *ac, int result,
47 			    void *buf, void *end);
48 
49 	/*
50 	 * Create authorizer for connecting to a service, and verify
51 	 * the response to authenticate the service.
52 	 */
53 	int (*create_authorizer)(struct ceph_auth_client *ac, int peer_type,
54 				 struct ceph_auth_handshake *auth);
55 	/* ensure that an existing authorizer is up to date */
56 	int (*update_authorizer)(struct ceph_auth_client *ac, int peer_type,
57 				 struct ceph_auth_handshake *auth);
58 	int (*verify_authorizer_reply)(struct ceph_auth_client *ac,
59 				       struct ceph_authorizer *a, size_t len);
60 	void (*destroy_authorizer)(struct ceph_auth_client *ac,
61 				   struct ceph_authorizer *a);
62 	void (*invalidate_authorizer)(struct ceph_auth_client *ac,
63 				      int peer_type);
64 
65 	/* reset when we (re)connect to a monitor */
66 	void (*reset)(struct ceph_auth_client *ac);
67 
68 	void (*destroy)(struct ceph_auth_client *ac);
69 };
70 
71 struct ceph_auth_client {
72 	u32 protocol;           /* CEPH_AUTH_* */
73 	void *private;          /* for use by protocol implementation */
74 	const struct ceph_auth_client_ops *ops;  /* null iff protocol==0 */
75 
76 	bool negotiating;       /* true if negotiating protocol */
77 	const char *name;       /* entity name */
78 	u64 global_id;          /* our unique id in system */
79 	const struct ceph_crypto_key *key;     /* our secret key */
80 	unsigned want_keys;     /* which services we want */
81 
82 	struct mutex mutex;
83 };
84 
85 extern struct ceph_auth_client *ceph_auth_init(const char *name,
86 					       const struct ceph_crypto_key *key);
87 extern void ceph_auth_destroy(struct ceph_auth_client *ac);
88 
89 extern void ceph_auth_reset(struct ceph_auth_client *ac);
90 
91 extern int ceph_auth_build_hello(struct ceph_auth_client *ac,
92 				 void *buf, size_t len);
93 extern int ceph_handle_auth_reply(struct ceph_auth_client *ac,
94 				  void *buf, size_t len,
95 				  void *reply_buf, size_t reply_len);
96 extern int ceph_entity_name_encode(const char *name, void **p, void *end);
97 
98 extern int ceph_build_auth(struct ceph_auth_client *ac,
99 		    void *msg_buf, size_t msg_len);
100 
101 extern int ceph_auth_is_authenticated(struct ceph_auth_client *ac);
102 extern int ceph_auth_create_authorizer(struct ceph_auth_client *ac,
103 				       int peer_type,
104 				       struct ceph_auth_handshake *auth);
105 extern void ceph_auth_destroy_authorizer(struct ceph_auth_client *ac,
106 					 struct ceph_authorizer *a);
107 extern int ceph_auth_update_authorizer(struct ceph_auth_client *ac,
108 				       int peer_type,
109 				       struct ceph_auth_handshake *a);
110 extern int ceph_auth_verify_authorizer_reply(struct ceph_auth_client *ac,
111 					     struct ceph_authorizer *a,
112 					     size_t len);
113 extern void ceph_auth_invalidate_authorizer(struct ceph_auth_client *ac,
114 					    int peer_type);
115 
116 #endif
117