1 #ifndef _FS_CEPH_AUTH_H
2 #define _FS_CEPH_AUTH_H
4 #include <linux/ceph/types.h>
5 #include <linux/ceph/buffer.h>
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).
14 struct ceph_auth_client
;
15 struct ceph_authorizer
;
18 struct ceph_auth_handshake
{
19 struct ceph_authorizer
*authorizer
;
21 size_t authorizer_buf_len
;
22 void *authorizer_reply_buf
;
23 size_t authorizer_reply_buf_len
;
24 int (*sign_message
)(struct ceph_auth_handshake
*auth
,
25 struct ceph_msg
*msg
);
26 int (*check_message_signature
)(struct ceph_auth_handshake
*auth
,
27 struct ceph_msg
*msg
);
30 struct ceph_auth_client_ops
{
34 * true if we are authenticated and can connect to
37 int (*is_authenticated
)(struct ceph_auth_client
*ac
);
40 * true if we should (re)authenticate, e.g., when our tickets
41 * are getting old and crusty.
43 int (*should_authenticate
)(struct ceph_auth_client
*ac
);
46 * build requests and process replies during monitor
47 * handshake. if handle_reply returns -EAGAIN, we build
50 int (*build_request
)(struct ceph_auth_client
*ac
, void *buf
, void *end
);
51 int (*handle_reply
)(struct ceph_auth_client
*ac
, int result
,
52 void *buf
, void *end
);
55 * Create authorizer for connecting to a service, and verify
56 * the response to authenticate the service.
58 int (*create_authorizer
)(struct ceph_auth_client
*ac
, int peer_type
,
59 struct ceph_auth_handshake
*auth
);
60 /* ensure that an existing authorizer is up to date */
61 int (*update_authorizer
)(struct ceph_auth_client
*ac
, int peer_type
,
62 struct ceph_auth_handshake
*auth
);
63 int (*verify_authorizer_reply
)(struct ceph_auth_client
*ac
,
64 struct ceph_authorizer
*a
, size_t len
);
65 void (*destroy_authorizer
)(struct ceph_auth_client
*ac
,
66 struct ceph_authorizer
*a
);
67 void (*invalidate_authorizer
)(struct ceph_auth_client
*ac
,
70 /* reset when we (re)connect to a monitor */
71 void (*reset
)(struct ceph_auth_client
*ac
);
73 void (*destroy
)(struct ceph_auth_client
*ac
);
75 int (*sign_message
)(struct ceph_auth_handshake
*auth
,
76 struct ceph_msg
*msg
);
77 int (*check_message_signature
)(struct ceph_auth_handshake
*auth
,
78 struct ceph_msg
*msg
);
81 struct ceph_auth_client
{
82 u32 protocol
; /* CEPH_AUTH_* */
83 void *private; /* for use by protocol implementation */
84 const struct ceph_auth_client_ops
*ops
; /* null iff protocol==0 */
86 bool negotiating
; /* true if negotiating protocol */
87 const char *name
; /* entity name */
88 u64 global_id
; /* our unique id in system */
89 const struct ceph_crypto_key
*key
; /* our secret key */
90 unsigned want_keys
; /* which services we want */
95 extern struct ceph_auth_client
*ceph_auth_init(const char *name
,
96 const struct ceph_crypto_key
*key
);
97 extern void ceph_auth_destroy(struct ceph_auth_client
*ac
);
99 extern void ceph_auth_reset(struct ceph_auth_client
*ac
);
101 extern int ceph_auth_build_hello(struct ceph_auth_client
*ac
,
102 void *buf
, size_t len
);
103 extern int ceph_handle_auth_reply(struct ceph_auth_client
*ac
,
104 void *buf
, size_t len
,
105 void *reply_buf
, size_t reply_len
);
106 extern int ceph_entity_name_encode(const char *name
, void **p
, void *end
);
108 extern int ceph_build_auth(struct ceph_auth_client
*ac
,
109 void *msg_buf
, size_t msg_len
);
111 extern int ceph_auth_is_authenticated(struct ceph_auth_client
*ac
);
112 extern int ceph_auth_create_authorizer(struct ceph_auth_client
*ac
,
114 struct ceph_auth_handshake
*auth
);
115 extern void ceph_auth_destroy_authorizer(struct ceph_auth_client
*ac
,
116 struct ceph_authorizer
*a
);
117 extern int ceph_auth_update_authorizer(struct ceph_auth_client
*ac
,
119 struct ceph_auth_handshake
*a
);
120 extern int ceph_auth_verify_authorizer_reply(struct ceph_auth_client
*ac
,
121 struct ceph_authorizer
*a
,
123 extern void ceph_auth_invalidate_authorizer(struct ceph_auth_client
*ac
,
126 static inline int ceph_auth_sign_message(struct ceph_auth_handshake
*auth
,
127 struct ceph_msg
*msg
)
129 if (auth
->sign_message
)
130 return auth
->sign_message(auth
, msg
);
135 int ceph_auth_check_message_signature(struct ceph_auth_handshake
*auth
,
136 struct ceph_msg
*msg
)
138 if (auth
->check_message_signature
)
139 return auth
->check_message_signature(auth
, msg
);