1*da6c28aaSamw /* 2*da6c28aaSamw * CDDL HEADER START 3*da6c28aaSamw * 4*da6c28aaSamw * The contents of this file are subject to the terms of the 5*da6c28aaSamw * Common Development and Distribution License (the "License"). 6*da6c28aaSamw * You may not use this file except in compliance with the License. 7*da6c28aaSamw * 8*da6c28aaSamw * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9*da6c28aaSamw * or http://www.opensolaris.org/os/licensing. 10*da6c28aaSamw * See the License for the specific language governing permissions 11*da6c28aaSamw * and limitations under the License. 12*da6c28aaSamw * 13*da6c28aaSamw * When distributing Covered Code, include this CDDL HEADER in each 14*da6c28aaSamw * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15*da6c28aaSamw * If applicable, add the following below this CDDL HEADER, with the 16*da6c28aaSamw * fields enclosed by brackets "[]" replaced with your own identifying 17*da6c28aaSamw * information: Portions Copyright [yyyy] [name of copyright owner] 18*da6c28aaSamw * 19*da6c28aaSamw * CDDL HEADER END 20*da6c28aaSamw */ 21*da6c28aaSamw /* 22*da6c28aaSamw * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23*da6c28aaSamw * Use is subject to license terms. 24*da6c28aaSamw */ 25*da6c28aaSamw 26*da6c28aaSamw #ifndef _SMBSRV_MSGBUF_H 27*da6c28aaSamw #define _SMBSRV_MSGBUF_H 28*da6c28aaSamw 29*da6c28aaSamw #pragma ident "%Z%%M% %I% %E% SMI" 30*da6c28aaSamw 31*da6c28aaSamw /* 32*da6c28aaSamw * Definition and interface for smb_msgbuf buffer management. The 33*da6c28aaSamw * smb_msgbuf interface is typically used to encode or decode SMB 34*da6c28aaSamw * data using sprintf/scanf style operations. It can also be used 35*da6c28aaSamw * for general purpose encoding and decoding. 36*da6c28aaSamw */ 37*da6c28aaSamw 38*da6c28aaSamw #include <sys/types.h> 39*da6c28aaSamw #include <smbsrv/smb_i18n.h> 40*da6c28aaSamw 41*da6c28aaSamw #ifdef __cplusplus 42*da6c28aaSamw extern "C" { 43*da6c28aaSamw #endif 44*da6c28aaSamw 45*da6c28aaSamw /* 46*da6c28aaSamw * When unicode strings are decoded, the resultant UTF-8 strings are 47*da6c28aaSamw * stored in dynamically allocated areas, which are held on a linked 48*da6c28aaSamw * list anchored at smb_msgbuf.mlist. The list is deallocated by 49*da6c28aaSamw * smb_msgbuf_term. 50*da6c28aaSamw */ 51*da6c28aaSamw typedef struct smb_msgbuf_mlist { 52*da6c28aaSamw struct smb_msgbuf_mlist *next; 53*da6c28aaSamw size_t size; 54*da6c28aaSamw } smb_msgbuf_mlist_t; 55*da6c28aaSamw 56*da6c28aaSamw /* 57*da6c28aaSamw * smb_smgbuf flags 58*da6c28aaSamw * 59*da6c28aaSamw * SMB_MSGBUF_UNICODE When there is a choice between unicode or ascii 60*da6c28aaSamw * formatting, select unicode processing. 61*da6c28aaSamw * SMB_MSGBUF_NOTERM Do not null terminate strings. 62*da6c28aaSamw */ 63*da6c28aaSamw #define SMB_MSGBUF_UNICODE 0x00000001 64*da6c28aaSamw #define SMB_MSGBUF_NOTERM 0x00000002 65*da6c28aaSamw 66*da6c28aaSamw /* 67*da6c28aaSamw * base: points to the beginning of the buffer 68*da6c28aaSamw * end: points to the limit of the buffer. 69*da6c28aaSamw * scan: points to the current offset. 70*da6c28aaSamw * max: holds the number of bytes in the buffer. 71*da6c28aaSamw * count: unused. 72*da6c28aaSamw * mlist: anchors the dynamically allocated memory list. 73*da6c28aaSamw * flags: see SMB_SMGBUF flags. 74*da6c28aaSamw */ 75*da6c28aaSamw typedef struct smb_msgbuf { 76*da6c28aaSamw uint8_t *base; 77*da6c28aaSamw uint8_t *end; 78*da6c28aaSamw uint8_t *scan; 79*da6c28aaSamw size_t count; 80*da6c28aaSamw size_t max; 81*da6c28aaSamw smb_msgbuf_mlist_t mlist; 82*da6c28aaSamw uint32_t flags; 83*da6c28aaSamw } smb_msgbuf_t; 84*da6c28aaSamw 85*da6c28aaSamw /* 86*da6c28aaSamw * List of smb_msgbuf_decode and smb_msgbuf_encode return values. 87*da6c28aaSamw */ 88*da6c28aaSamw #define SMB_MSGBUF_SUCCESS 0 89*da6c28aaSamw #define SMB_MSGBUF_UNDERFLOW -1 90*da6c28aaSamw #define SMB_MSGBUF_OVERFLOW SMB_MSGBUF_UNDERFLOW 91*da6c28aaSamw #define SMB_MSGBUF_INVALID_FORMAT -2 92*da6c28aaSamw #define SMB_MSGBUF_INVALID_HEADER -3 93*da6c28aaSamw #define SMB_MSGBUF_DATA_ERROR -4 94*da6c28aaSamw 95*da6c28aaSamw /* 96*da6c28aaSamw * smb_msgbuf_init must be called to associate the smb_msgbuf_t with 97*da6c28aaSamw * a buffer before any encode or decode operations may be performed. 98*da6c28aaSamw * 99*da6c28aaSamw * smb_msgbuf_term must be called to free any dynamically allocated memory 100*da6c28aaSamw * that was acquired during encode or decode operations. At this time 101*da6c28aaSamw * the only operation that allocates memory is a unicode string decode. 102*da6c28aaSamw * 103*da6c28aaSamw * If there are no errors, smb_msgbuf_decode and smb_msgbuf_encode return 104*da6c28aaSamw * the number of bytes decoded or encoded. If there is a problem they 105*da6c28aaSamw * return -ve error codes. 106*da6c28aaSamw */ 107*da6c28aaSamw extern void smb_msgbuf_init(smb_msgbuf_t *, uint8_t *, size_t, uint32_t); 108*da6c28aaSamw extern void smb_msgbuf_term(smb_msgbuf_t *); 109*da6c28aaSamw extern int smb_msgbuf_decode(smb_msgbuf_t *, char *, ...); 110*da6c28aaSamw extern int smb_msgbuf_encode(smb_msgbuf_t *, char *, ...); 111*da6c28aaSamw extern size_t smb_msgbuf_used(smb_msgbuf_t *); 112*da6c28aaSamw extern size_t smb_msgbuf_size(smb_msgbuf_t *); 113*da6c28aaSamw extern uint8_t *smb_msgbuf_base(smb_msgbuf_t *); 114*da6c28aaSamw extern void smb_msgbuf_word_align(smb_msgbuf_t *); 115*da6c28aaSamw extern void smb_msgbuf_dword_align(smb_msgbuf_t *); 116*da6c28aaSamw extern int smb_msgbuf_has_space(smb_msgbuf_t *, size_t); 117*da6c28aaSamw extern void smb_msgbuf_fset(smb_msgbuf_t *, uint32_t); 118*da6c28aaSamw extern void smb_msgbuf_fclear(smb_msgbuf_t *, uint32_t); 119*da6c28aaSamw 120*da6c28aaSamw #ifdef __cplusplus 121*da6c28aaSamw } 122*da6c28aaSamw #endif 123*da6c28aaSamw 124*da6c28aaSamw #endif /* _SMBSRV_MSGBUF_H */ 125