[deb_libnfs.git] / include / nfsc / libnfs-zdr.h

/*
   Copyright (C) 2012 by Ronnie Sahlberg <ronniesahlberg@gmail.com>

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as published by
   the Free Software Foundation; either version 2.1 of the License, or
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public License
   along with this program; if not, see <http://www.gnu.org/licenses/>.
*/
/*
 * This file contains definitions for the built in ZDR implementation.
 * This is a very limited ZDR subset that can only marshal to/from a momory buffer,
 * i.e. zdrmem_create() buffers.
 * It aims to be compatible with normal rpcgen generated functions.
 */

/************************************************************
 * Definitions copied from RFC 5531
 * and slightly modified.
 ************************************************************/

#ifndef _LIBNFS_ZDR_H_
#define _LIBNFS_ZDR_H_

#ifdef WIN32
#ifndef CADDR_T_DEFINED
#define CADDR_T_DEFINED
typedef char *caddr_t;
#endif
#endif

#include <stdio.h>
#include <assert.h>
#include <stdint.h>
#include <sys/types.h>

#ifdef __cplusplus
extern "C" {
#endif

#define _RPC_RPC_H 1
#define _RPC_ZDR_H 1
#define _RPC_AUTH_H 1

/* we dont need these */
typedef void CLIENT;
struct svc_req {
	int _dummy_;
};
typedef void SVCXPRT;


#define ZDR_INLINE(...) NULL
#define IZDR_PUT_U_LONG(...)		assert(0)
#define IZDR_GET_U_LONG(...)		(assert(0), 0)
#define IZDR_PUT_LONG(...)		assert(0)
#define IZDR_GET_LONG(...)		(assert(0), 0)
#define IZDR_PUT_BOOL(...)		assert(0)
#define IZDR_GET_BOOL(...)		(assert(0), 0)

#ifndef TRUE
#define TRUE		1
#endif
#ifndef FALSE
#define FALSE		0
#endif

enum zdr_op {
	ZDR_ENCODE = 0,
	ZDR_DECODE = 1
};

struct zdr_mem {
       struct zdr_mem *next;
       caddr_t buf;
       uint32_t size;
};

struct ZDR {
	enum zdr_op x_op;
	caddr_t buf;
	int size;
	int pos;
	struct zdr_mem *mem;
};
typedef struct ZDR ZDR;


typedef uint32_t u_int;
typedef uint32_t enum_t;
typedef uint32_t bool_t;

typedef int (*zdrproc_t) (ZDR *, void *,...);

#define AUTH_NONE 0
#define AUTH_NULL 0
#define AUTH_UNIX 1

struct opaque_auth {
	uint32_t oa_flavor;
	caddr_t  oa_base;
	uint32_t oa_length;
};
extern struct opaque_auth _null_auth;

struct AUTH {
	struct opaque_auth	ah_cred;
	struct opaque_auth	ah_verf;
	caddr_t ah_private;
};

#define RPC_MSG_VERSION	2

enum msg_type {
	CALL  = 0,
	REPLY = 1
};

enum reply_stat {
	MSG_ACCEPTED=0,
	MSG_DENIED=1
};

enum accept_stat {
	SUCCESS       = 0,
	PROG_UNAVAIL  = 1,
	PROG_MISMATCH = 2,
	PROC_UNAVAIL  = 3,
	GARBAGE_ARGS  = 4,
	SYSTEM_ERR    = 5
};

enum reject_stat {
	RPC_MISMATCH = 0,
	AUTH_ERROR   = 1
};

enum auth_stat {
	AUTH_OK=0,
	/*
	 * failed at remote end
	 */
	AUTH_BADCRED      = 1,		/* bogus credentials (seal broken) */
	AUTH_REJECTEDCRED = 2,		/* client should begin new session */
	AUTH_BADVERF      = 3,		/* bogus verifier (seal broken) */
	AUTH_REJECTEDVERF = 4,		/* verifier expired or was replayed */
	AUTH_TOOWEAK      = 5,		/* rejected due to security reasons */
	/*
	 * failed locally
	*/
	AUTH_INVALIDRESP  = 6,		/* bogus response verifier */
	AUTH_FAILED       = 7		/* some unknown reason */
};

struct call_body {
	uint32_t rpcvers;
	uint32_t prog;
	uint32_t vers;
	uint32_t proc;
	struct opaque_auth cred;
	struct opaque_auth verf;
};

struct accepted_reply {
	struct opaque_auth	verf;
	uint32_t		stat;
	union {
		struct {
			caddr_t	where;
			zdrproc_t proc;
		} results;
		struct {
			uint32_t	low;
			uint32_t	high;
		} mismatch_info;
	} reply_data;
};

struct rejected_reply {
	enum reject_stat stat;
	union {
		struct {
			uint32_t low;
			uint32_t high;
		} mismatch_info;
		enum auth_stat stat;
	} reject_data;
};

struct reply_body {
	uint32_t stat;
	union {
		struct accepted_reply areply;
		struct rejected_reply rreply;
	} reply;
};

struct rpc_msg {
	uint32_t		  xid;

	uint32_t		  direction;
	union {
		struct call_body  cbody;
		struct reply_body rbody;
	} body;
};

#define zdrmem_create libnfs_zdrmem_create
void libnfs_zdrmem_create(ZDR *zdrs, const caddr_t addr, uint32_t size, enum zdr_op xop);

#define zdr_destroy libnfs_zdr_destroy
void libnfs_zdr_destroy(ZDR *zdrs);

#define zdr_bytes libnfs_zdr_bytes
bool_t libnfs_zdr_bytes(ZDR *zdrs, char **bufp, uint32_t *size, uint32_t maxsize);

#define zdr_u_int libnfs_zdr_u_int
bool_t libnfs_zdr_u_int(ZDR *zdrs, uint32_t *u);

#define zdr_int libnfs_zdr_int
bool_t libnfs_zdr_int(ZDR *zdrs, int32_t *i);

#define zdr_u_quad_t libnfs_zdr_u_quad_t
bool_t libnfs_zdr_u_quad_t(ZDR *zdrs, uint64_t *u);

#define zdr_quad_t libnfs_zdr_quad_t
bool_t libnfs_zdr_quad_t(ZDR *zdrs, int64_t *i);

#define zdr_enum libnfs_zdr_enum
bool_t libnfs_zdr_enum(ZDR *zdrs, enum_t *e);

#define zdr_bool libnfs_zdr_bool
bool_t libnfs_zdr_bool(ZDR *zdrs, bool_t *b);

#define zdr_void libnfs_zdr_void
bool_t libnfs_zdr_void(void);

#define zdr_pointer libnfs_zdr_pointer
bool_t libnfs_zdr_pointer(ZDR *zdrs, char **objp, uint32_t size, zdrproc_t proc);

#define zdr_opaque libnfs_zdr_opaque
bool_t libnfs_zdr_opaque(ZDR *zdrs, char *objp, uint32_t size);

#define zdr_string libnfs_zdr_string
bool_t libnfs_zdr_string(ZDR *zdrs, char **strp, uint32_t maxsize);

#define zdr_array libnfs_zdr_array
bool_t libnfs_zdr_array(ZDR *zdrs, char **arrp, uint32_t *size, uint32_t maxsize, uint32_t elsize, zdrproc_t proc);

#define zdr_setpos libnfs_zdr_setpos
bool_t libnfs_zdr_setpos(ZDR *zdrs, uint32_t pos);

#define zdr_getpos libnfs_zdr_getpos
uint32_t libnfs_zdr_getpos(ZDR *zdrs);

#define zdr_free libnfs_zdr_free
void libnfs_zdr_free(zdrproc_t proc, char *objp);

#define zdr_callmsg libnfs_zdr_callmsg
bool_t libnfs_zdr_callmsg(ZDR *zdrs, struct rpc_msg *msg);

#define zdr_replymsg libnfs_zdr_replymsg
bool_t libnfs_zdr_replymsg(ZDR *zdrs, struct rpc_msg *msg);

#define authnone_create libnfs_authnone_create
struct AUTH *libnfs_authnone_create(void);

#define authunix_create libnfs_authunix_create
struct AUTH *libnfs_authunix_create(char *host, uint32_t uid, uint32_t gid, uint32_t len, uint32_t *groups);

#define authunix_create_default libnfs_authunix_create_default
struct AUTH *libnfs_authunix_create_default(void);

#define auth_destroy libnfs_auth_destroy
void libnfs_auth_destroy(struct AUTH *auth);

#ifdef __cplusplus
}
#endif

#endif
Commit	Line	Data
	1	/*
	2	Copyright (C) 2012 by Ronnie Sahlberg <ronniesahlberg@gmail.com>
	3
	4	This program is free software; you can redistribute it and/or modify
	5	it under the terms of the GNU Lesser General Public License as published by
	6	the Free Software Foundation; either version 2.1 of the License, or
	7	(at your option) any later version.
	8
	9	This program is distributed in the hope that it will be useful,
	10	but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	GNU Lesser General Public License for more details.
	13
	14	You should have received a copy of the GNU Lesser General Public License
	15	along with this program; if not, see <http://www.gnu.org/licenses/>.
	16	*/
	17	/*
	18	* This file contains definitions for the built in ZDR implementation.
	19	* This is a very limited ZDR subset that can only marshal to/from a momory buffer,
	20	* i.e. zdrmem_create() buffers.
	21	* It aims to be compatible with normal rpcgen generated functions.
	22	*/
	23
	24	/************************************************************
	25	* Definitions copied from RFC 5531
	26	* and slightly modified.
	27	************************************************************/
	28
	29	#ifndef _LIBNFS_ZDR_H_
	30	#define _LIBNFS_ZDR_H_
	31
	32	#ifdef WIN32
	33	#ifndef CADDR_T_DEFINED
	34	#define CADDR_T_DEFINED
	35	typedef char *caddr_t;
	36	#endif
	37	#endif
	38
	39	#include <stdio.h>
	40	#include <assert.h>
	41	#include <stdint.h>
	42	#include <sys/types.h>
	43
	44	#ifdef __cplusplus
	45	extern "C" {
	46	#endif
	47
	48	#define _RPC_RPC_H 1
	49	#define _RPC_ZDR_H 1
	50	#define _RPC_AUTH_H 1
	51
	52	/* we dont need these */
	53	typedef void CLIENT;
	54	struct svc_req {
	55	int _dummy_;
	56	};
	57	typedef void SVCXPRT;
	58
	59
	60
	61
	62
	63	#define ZDR_INLINE(...) NULL
	64	#define IZDR_PUT_U_LONG(...) assert(0)
	65	#define IZDR_GET_U_LONG(...) (assert(0), 0)
	66	#define IZDR_PUT_LONG(...) assert(0)
	67	#define IZDR_GET_LONG(...) (assert(0), 0)
	68	#define IZDR_PUT_BOOL(...) assert(0)
	69	#define IZDR_GET_BOOL(...) (assert(0), 0)
	70
	71	#ifndef TRUE
	72	#define TRUE 1
	73	#endif
	74	#ifndef FALSE
	75	#define FALSE 0
	76	#endif
	77
	78	enum zdr_op {
	79	ZDR_ENCODE = 0,
	80	ZDR_DECODE = 1
	81	};
	82
	83	struct zdr_mem {
	84	struct zdr_mem *next;
	85	caddr_t buf;
	86	uint32_t size;
	87	};
	88
	89	struct ZDR {
	90	enum zdr_op x_op;
	91	caddr_t buf;
	92	int size;
	93	int pos;
	94	struct zdr_mem *mem;
	95	};
	96	typedef struct ZDR ZDR;
	97
	98
	99	typedef uint32_t u_int;
	100	typedef uint32_t enum_t;
	101	typedef uint32_t bool_t;
	102
	103	typedef int (zdrproc_t) (ZDR , void *,...);
	104
	105	#define AUTH_NONE 0
	106	#define AUTH_NULL 0
	107	#define AUTH_UNIX 1
	108
	109	struct opaque_auth {
	110	uint32_t oa_flavor;
	111	caddr_t oa_base;
	112	uint32_t oa_length;
	113	};
	114	extern struct opaque_auth _null_auth;
	115
	116	struct AUTH {
	117	struct opaque_auth ah_cred;
	118	struct opaque_auth ah_verf;
	119	caddr_t ah_private;
	120	};
	121
	122	#define RPC_MSG_VERSION 2
	123
	124	enum msg_type {
	125	CALL = 0,
	126	REPLY = 1
	127	};
	128
	129	enum reply_stat {
	130	MSG_ACCEPTED=0,
	131	MSG_DENIED=1
	132	};
	133
	134	enum accept_stat {
	135	SUCCESS = 0,
	136	PROG_UNAVAIL = 1,
	137	PROG_MISMATCH = 2,
	138	PROC_UNAVAIL = 3,
	139	GARBAGE_ARGS = 4,
	140	SYSTEM_ERR = 5
	141	};
	142
	143	enum reject_stat {
	144	RPC_MISMATCH = 0,
	145	AUTH_ERROR = 1
	146	};
	147
	148	enum auth_stat {
	149	AUTH_OK=0,
	150	/*
	151	* failed at remote end
	152	*/
	153	AUTH_BADCRED = 1, /* bogus credentials (seal broken) */
	154	AUTH_REJECTEDCRED = 2, /* client should begin new session */
	155	AUTH_BADVERF = 3, /* bogus verifier (seal broken) */
	156	AUTH_REJECTEDVERF = 4, /* verifier expired or was replayed */
	157	AUTH_TOOWEAK = 5, /* rejected due to security reasons */
	158	/*
	159	* failed locally
	160	*/
	161	AUTH_INVALIDRESP = 6, /* bogus response verifier */
	162	AUTH_FAILED = 7 /* some unknown reason */
	163	};
	164
	165	struct call_body {
	166	uint32_t rpcvers;
	167	uint32_t prog;
	168	uint32_t vers;
	169	uint32_t proc;
	170	struct opaque_auth cred;
	171	struct opaque_auth verf;
	172	};
	173
	174	struct accepted_reply {
	175	struct opaque_auth verf;
	176	uint32_t stat;
	177	union {
	178	struct {
	179	caddr_t where;
	180	zdrproc_t proc;
	181	} results;
	182	struct {
	183	uint32_t low;
	184	uint32_t high;
	185	} mismatch_info;
	186	} reply_data;
	187	};
	188
	189	struct rejected_reply {
	190	enum reject_stat stat;
	191	union {
	192	struct {
	193	uint32_t low;
	194	uint32_t high;
	195	} mismatch_info;
	196	enum auth_stat stat;
	197	} reject_data;
	198	};
	199
	200	struct reply_body {
	201	uint32_t stat;
	202	union {
	203	struct accepted_reply areply;
	204	struct rejected_reply rreply;
	205	} reply;
	206	};
	207
	208	struct rpc_msg {
	209	uint32_t xid;
	210
	211	uint32_t direction;
	212	union {
	213	struct call_body cbody;
	214	struct reply_body rbody;
	215	} body;
	216	};
	217
	218	#define zdrmem_create libnfs_zdrmem_create
	219	void libnfs_zdrmem_create(ZDR *zdrs, const caddr_t addr, uint32_t size, enum zdr_op xop);
	220
	221	#define zdr_destroy libnfs_zdr_destroy
	222	void libnfs_zdr_destroy(ZDR *zdrs);
	223
	224	#define zdr_bytes libnfs_zdr_bytes
	225	bool_t libnfs_zdr_bytes(ZDR zdrs, char bufp, uint32_t size, uint32_t maxsize);
	226
	227	#define zdr_u_int libnfs_zdr_u_int
	228	bool_t libnfs_zdr_u_int(ZDR zdrs, uint32_t u);
	229
	230	#define zdr_int libnfs_zdr_int
	231	bool_t libnfs_zdr_int(ZDR zdrs, int32_t i);
	232
	233	#define zdr_u_quad_t libnfs_zdr_u_quad_t
	234	bool_t libnfs_zdr_u_quad_t(ZDR zdrs, uint64_t u);
	235
	236	#define zdr_quad_t libnfs_zdr_quad_t
	237	bool_t libnfs_zdr_quad_t(ZDR zdrs, int64_t i);
	238
	239	#define zdr_enum libnfs_zdr_enum
	240	bool_t libnfs_zdr_enum(ZDR zdrs, enum_t e);
	241
	242	#define zdr_bool libnfs_zdr_bool
	243	bool_t libnfs_zdr_bool(ZDR zdrs, bool_t b);
	244
	245	#define zdr_void libnfs_zdr_void
	246	bool_t libnfs_zdr_void(void);
	247
	248	#define zdr_pointer libnfs_zdr_pointer
	249	bool_t libnfs_zdr_pointer(ZDR zdrs, char *objp, uint32_t size, zdrproc_t proc);
	250
	251	#define zdr_opaque libnfs_zdr_opaque
	252	bool_t libnfs_zdr_opaque(ZDR zdrs, char objp, uint32_t size);
	253
	254	#define zdr_string libnfs_zdr_string
	255	bool_t libnfs_zdr_string(ZDR zdrs, char *strp, uint32_t maxsize);
	256
	257	#define zdr_array libnfs_zdr_array
	258	bool_t libnfs_zdr_array(ZDR zdrs, char arrp, uint32_t size, uint32_t maxsize, uint32_t elsize, zdrproc_t proc);
	259
	260	#define zdr_setpos libnfs_zdr_setpos
	261	bool_t libnfs_zdr_setpos(ZDR *zdrs, uint32_t pos);
	262
	263	#define zdr_getpos libnfs_zdr_getpos
	264	uint32_t libnfs_zdr_getpos(ZDR *zdrs);
	265
	266	#define zdr_free libnfs_zdr_free
	267	void libnfs_zdr_free(zdrproc_t proc, char *objp);
	268
	269	#define zdr_callmsg libnfs_zdr_callmsg
	270	bool_t libnfs_zdr_callmsg(ZDR zdrs, struct rpc_msg msg);
	271
	272	#define zdr_replymsg libnfs_zdr_replymsg
	273	bool_t libnfs_zdr_replymsg(ZDR zdrs, struct rpc_msg msg);
	274
	275	#define authnone_create libnfs_authnone_create
	276	struct AUTH *libnfs_authnone_create(void);
	277
	278	#define authunix_create libnfs_authunix_create
	279	struct AUTH libnfs_authunix_create(char host, uint32_t uid, uint32_t gid, uint32_t len, uint32_t *groups);
	280
	281	#define authunix_create_default libnfs_authunix_create_default
	282	struct AUTH *libnfs_authunix_create_default(void);
	283
	284	#define auth_destroy libnfs_auth_destroy
	285	void libnfs_auth_destroy(struct AUTH *auth);
	286
	287	#ifdef __cplusplus
	288	}
	289	#endif
	290
	291	#endif