[linux-2.6-block.git] / fs / ceph / auth.h

#ifndef _FS_CEPH_AUTH_H
#define _FS_CEPH_AUTH_H

#include "types.h"
#include "buffer.h"

/*
 * Abstract interface for communicating with the authenticate module.
 * There is some handshake that takes place between us and the monitor
 * to acquire the necessary keys.  These are used to generate an
 * 'authorizer' that we use when connecting to a service (mds, osd).
 */

struct ceph_auth_client;
struct ceph_authorizer;

struct ceph_auth_client_ops {
	/*
	 * true if we are authenticated and can connect to
	 * services.
	 */
	int (*is_authenticated)(struct ceph_auth_client *ac);

	/*
	 * build requests and process replies during monitor
	 * handshake.  if handle_reply returns -EAGAIN, we build
	 * another request.
	 */
	int (*build_request)(struct ceph_auth_client *ac, void *buf, void *end);
	int (*handle_reply)(struct ceph_auth_client *ac, int result,
			    void *buf, void *end);

	/*
	 * Create authorizer for connecting to a service, and verify
	 * the response to authenticate the service.
	 */
	int (*create_authorizer)(struct ceph_auth_client *ac, int peer_type,
				 struct ceph_authorizer **a,
				 void **buf, size_t *len,
				 void **reply_buf, size_t *reply_len);
	int (*verify_authorizer_reply)(struct ceph_auth_client *ac,
				       struct ceph_authorizer *a, size_t len);
	void (*destroy_authorizer)(struct ceph_auth_client *ac,
				   struct ceph_authorizer *a);
	void (*invalidate_authorizer)(struct ceph_auth_client *ac,
				      int peer_type);

	/* reset when we (re)connect to a monitor */
	void (*reset)(struct ceph_auth_client *ac);

	void (*destroy)(struct ceph_auth_client *ac);
};

struct ceph_auth_client {
	u32 protocol;           /* CEPH_AUTH_* */
	void *private;          /* for use by protocol implementation */
	const struct ceph_auth_client_ops *ops;  /* null iff protocol==0 */

	bool negotiating;       /* true if negotiating protocol */
	const char *name;       /* entity name */
	u64 global_id;          /* our unique id in system */
	const char *secret;     /* our secret key */
	unsigned want_keys;     /* which services we want */
};

extern struct ceph_auth_client *ceph_auth_init(const char *name,
					       const char *secret);
extern void ceph_auth_destroy(struct ceph_auth_client *ac);

extern void ceph_auth_reset(struct ceph_auth_client *ac);

extern int ceph_auth_build_hello(struct ceph_auth_client *ac,
				 void *buf, size_t len);
extern int ceph_handle_auth_reply(struct ceph_auth_client *ac,
				  void *buf, size_t len,
				  void *reply_buf, size_t reply_len);
extern int ceph_entity_name_encode(const char *name, void **p, void *end);

extern int ceph_build_auth(struct ceph_auth_client *ac,
		    void *msg_buf, size_t msg_len);

extern int ceph_auth_is_authenticated(struct ceph_auth_client *ac);

#endif
Commit	Line	Data
4e7a5dcd SW	1	#ifndef _FS_CEPH_AUTH_H
	2	#define _FS_CEPH_AUTH_H
	3
	4	#include "types.h"
	5	#include "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_client_ops {
	18	/*
	19	* true if we are authenticated and can connect to
	20	* services.
	21	*/
	22	int (is_authenticated)(struct ceph_auth_client ac);
	23
	24	/*
	25	* build requests and process replies during monitor
	26	* handshake. if handle_reply returns -EAGAIN, we build
	27	* another request.
	28	*/
	29	int (build_request)(struct ceph_auth_client ac, void buf, void end);
	30	int (handle_reply)(struct ceph_auth_client ac, int result,
	31	void buf, void end);
	32
	33	/*
	34	* Create authorizer for connecting to a service, and verify
	35	* the response to authenticate the service.
	36	*/
	37	int (create_authorizer)(struct ceph_auth_client ac, int peer_type,
	38	struct ceph_authorizer **a,
	39	void *buf, size_t len,
	40	void *reply_buf, size_t reply_len);
	41	int (verify_authorizer_reply)(struct ceph_auth_client ac,
	42	struct ceph_authorizer *a, size_t len);
	43	void (destroy_authorizer)(struct ceph_auth_client ac,
	44	struct ceph_authorizer *a);
9bd2e6f8 SW	45	void (invalidate_authorizer)(struct ceph_auth_client ac,
9bd2e6f8 SW	46	int peer_type);
4e7a5dcd SW	47
	48	/* reset when we (re)connect to a monitor */
	49	void (reset)(struct ceph_auth_client ac);
	50
	51	void (destroy)(struct ceph_auth_client ac);
	52	};
	53
	54	struct ceph_auth_client {
	55	u32 protocol; /* CEPH_AUTH_* */
	56	void private; / for use by protocol implementation */
	57	const struct ceph_auth_client_ops ops; / null iff protocol==0 */
	58
	59	bool negotiating; /* true if negotiating protocol */
	60	const char name; / entity name */
	61	u64 global_id; /* our unique id in system */
	62	const char secret; / our secret key */
	63	unsigned want_keys; /* which services we want */
	64	};
	65
	66	extern struct ceph_auth_client ceph_auth_init(const char name,
	67	const char *secret);
	68	extern void ceph_auth_destroy(struct ceph_auth_client *ac);
	69
	70	extern void ceph_auth_reset(struct ceph_auth_client *ac);
	71
	72	extern int ceph_auth_build_hello(struct ceph_auth_client *ac,
	73	void *buf, size_t len);
	74	extern int ceph_handle_auth_reply(struct ceph_auth_client *ac,
	75	void *buf, size_t len,
	76	void *reply_buf, size_t reply_len);
	77	extern int ceph_entity_name_encode(const char name, void p, void end);
	78
9bd2e6f8 SW	79	extern int ceph_build_auth(struct ceph_auth_client *ac,
	80	void *msg_buf, size_t msg_len);
	81
	82	extern int ceph_auth_is_authenticated(struct ceph_auth_client *ac);
	83
4e7a5dcd	84	#endif