source: trunk/include/smb_deps.h @ 60

/*
 * This file contains miscellaneous pieces of code which regfio.c
 * depends upon, from the Samba Subversion tree.  See:
 *   http://websvn.samba.org/cgi-bin/viewcvs.cgi/trunk/source/
 *
 * Copyright (C) 2005 Timothy D. Morgan
 * Copyright (C) 1992-2005 Samba development team 
 *               (see individual files under Subversion for details.)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License.
 * 
 * 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * $Id: smb_deps.h 53 2005-09-04 21:04:58Z tim $
 */

#include <stdlib.h>
#include <stdbool.h>
#include <stdio.h>
#include <string.h>
#include <errno.h>
#include <fcntl.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <unistd.h>

#include "byteorder.h"

#define DEBUG(lvl,body) 0

void* zalloc(size_t size);
void* zcalloc(size_t size, unsigned int count);

/* From includes.h */

#define uint8 unsigned char
#define int16 short
#define uint16 unsigned short
#define int32 int
#define uint32 unsigned int

#define SMB_STRUCT_STAT struct stat
#define QSORT_CAST (int (*)(const void *, const void *))

#define MIN(a,b) ((a)<(b)?(a):(b))
#define MAX(a,b) ((a)>(b)?(a):(b))

extern int DEBUGLEVEL;

#define DLIST_ADD(list, p) \
{ \
        if (!(list)) { \
                (list) = (p); \
                (p)->next = (p)->prev = NULL; \
        } else { \
                (list)->prev = (p); \
                (p)->next = (list); \
                (p)->prev = NULL; \
                (list) = (p); \
        }\
}

/* End of stuff from includes.h */

/* From smb.h */

#define MAXSUBAUTHS 15

typedef struct sid_info
{
  uint8  sid_rev_num;             /**< SID revision number */
  uint8  num_auths;               /**< Number of sub-authorities */
  uint8  id_auth[6];              /**< Identifier Authority */
  /*
   *  Pointer to sub-authorities.
   *
   * @note The values in these uint32's are in *native* byteorder, not
   * neccessarily little-endian...... JRA.
   */
  uint32 sub_auths[MAXSUBAUTHS];
} DOM_SID;

typedef struct nttime_info
{
  uint32 low;
  uint32 high;
} NTTIME;

/* End of stuff from smb.h */

/* From smb_macros.h */

#define TALLOC_ZERO_P(ctx, type) (type *)_talloc_zero(ctx, sizeof(type), #type)
#define SMB_MALLOC_P(type) (type *)malloc_(sizeof(type))
#define TALLOC_ARRAY(ctx, type, count) (type *)_talloc_array(ctx, sizeof(type), count, #type)
#define TALLOC_ZERO_ARRAY(ctx, type, count) (type *)_talloc_zero_array(ctx, sizeof(type), count, #type)
#define SAFE_FREE(x) do { if ((x) != NULL) {free(x); x=NULL;} } while(0)

/* End of stuff from smb_macros.h */

/* From ntdomain.h */

struct uuid {
       uint32 time_low;
       uint16 time_mid;
       uint16 time_hi_and_version;
       uint8  clock_seq[2];
       uint8  node[6];
};

typedef struct _prs_struct {
        bool io; /* parsing in or out of data stream */
        /* 
         * If the (incoming) data is big-endian. On output we are
          * always little-endian.
           */ 
           bool bigendian_data;
           uint8 align; /* data alignment */
           bool is_dynamic; /* Do we own this memory or not ? */
           uint32 data_offset; /* Current working offset into data. */
           uint32 buffer_size; /* Current allocated size of the buffer. */
           uint32 grow_size; /* size requested via prs_grow() calls */
           char *data_p; /* The buffer itself. */
           void *mem_ctx; /* When unmarshalling, use this.... */
} prs_struct;

#define MARSHALL 0
#define UNMARSHALL 1

#define RPC_LITTLE_ENDIAN  0
#define RPC_PARSE_ALIGN    4


/* End of stuff from ntdomain.h */

/* From nt_status.h */

typedef uint32 NTSTATUS;
typedef uint32 WERROR;

/* End of stuff from nt_status.h */

/* From lib/time.c */

#define CHAR_BIT 8
#define TIME_T_MIN ((time_t)0 < (time_t) -1 ? (time_t) 0 \
                    : ~ (time_t) 0 << (sizeof (time_t) * CHAR_BIT - 1))
#define TIME_T_MAX (~ (time_t) 0 - TIME_T_MIN)
#define TIME_FIXUP_CONSTANT (369.0*365.25*24*60*60-(3.0*24*60*60+6.0*60*60))

void unix_to_nt_time(NTTIME *nt, time_t t);
time_t nt_time_to_unix(NTTIME *nt);

/* End of stuff from lib/time.c */

/* From rpc_dce.h */

#define MAX_PDU_FRAG_LEN 0x10b8 /* this is what w2k sets */

/* End of stuff from rpc_dce.h */

/* From parse_prs.h */

bool prs_grow(prs_struct *ps, uint32 extra_space);
bool prs_align(prs_struct *ps);
bool prs_init(prs_struct *ps, uint32 size, void *ctx, bool io);
char *prs_mem_get(prs_struct *ps, uint32 extra_size);
bool prs_uint32(const char *name, prs_struct *ps, int depth, uint32 *data32);
bool prs_uint32s(bool charmode, const char *name, prs_struct *ps, 
                 int depth, uint32 *data32s, int len);
bool prs_uint16(const char *name, prs_struct *ps, int depth, uint16 *data16);
bool prs_uint16_pre(const char *name, prs_struct *ps, int depth, 
                    uint16 *data16, uint32 *offset);
bool prs_uint16_post(const char *name, prs_struct *ps, int depth, 
                     uint16 *data16, uint32 ptr_uint16, uint32 start_offset);
bool prs_uint8(const char *name, prs_struct *ps, int depth, uint8 *data8);
bool prs_uint8s(bool charmode, const char *name, prs_struct *ps, int depth, 
                uint8* data8s, int len);
bool prs_set_offset(prs_struct *ps, uint32 offset);

/* End of stuff from parse_prs.h */



/* buffer used by \winreg\ calls to fill in arbitrary REG_XXX values.
   It *may* look like a UNISTR2 but it is *not*.  This is not a goof
   by the winreg developers.  It is a generic buffer.  buffer length
   is stored in bytes (not # of uint16's) */

typedef struct {
        uint32 buf_max_len;
        uint32 offset;
        uint32 buf_len;
        uint16 *buffer;
} REGVAL_BUFFER;

typedef struct {
        uint32 buf_len;
        uint16 *buffer; /* data */
} BUFFER5;


/********************************************************************** 
 * UNICODE string variations
 **********************************************************************/


typedef struct {                /* UNISTR - unicode string size and buffer */
        uint16 *buffer;         /* unicode characters. ***MUST*** be 
                                   little-endian. ***MUST*** be null-terminated */
} UNISTR;

typedef struct {                /* UNISTR2 - unicode string size (in 
                                   uint16 unicode chars) and buffer */
        uint32 uni_max_len;
        uint32 offset;
        uint32 uni_str_len;
        uint16 *buffer;         /* unicode characters. ***MUST*** be little-endian. 
                                  **must** be null-terminated and the uni_str_len 
                                  should include the NULL character */
} UNISTR2;

/* i think this is the same as a BUFFER5 used in the spoolss code --jerry */
/* not sure about how the termination matches between the uint16 buffers thought */

typedef struct {                /* UNISTR3 - XXXX not sure about this structure */
        uint32 uni_str_len;
        UNISTR str;
} UNISTR3;

typedef struct {                /* Buffer wrapped around a UNISTR2 */
        uint16 length;          /* number of bytes not counting NULL terminatation */
        uint16 size;            /* number of bytes including NULL terminatation */
        UNISTR2 *string;
} UNISTR4;

typedef struct {
        uint32 count;
        UNISTR4 *strings;
} UNISTR4_ARRAY;


/********************************************************************** 
 * String variations
 **********************************************************************/

typedef struct {                /* STRING2 - string size (in uint8 chars) and buffer */
        uint32 str_max_len;
        uint32 offset;
        uint32 str_str_len;
        uint8  *buffer;         /* uint8 characters. **NOT** necessarily null-terminated */
} STRING2;


/* From rpc_secdesc.h */

typedef struct security_info_info
{
        uint32 mask;

} SEC_ACCESS;

typedef struct security_ace_info
{
        uint8 type;  /* xxxx_xxxx_ACE_TYPE - e.g allowed / denied etc */
        uint8 flags; /* xxxx_INHERIT_xxxx - e.g OBJECT_INHERIT_ACE */
        uint16 size;

        SEC_ACCESS info;

        /* this stuff may be present when type is XXXX_TYPE_XXXX_OBJECT */
        uint32  obj_flags; /* xxxx_ACE_OBJECT_xxxx e.g present/inherited present etc */
        struct uuid obj_guid;  /* object GUID */
        struct uuid inh_guid;  /* inherited object GUID */              
        /* eof object stuff */

        DOM_SID trustee;

} SEC_ACE;

typedef struct security_acl_info
{
        uint16 revision; /* 0x0003 */
        uint16 size; /* size in bytes of the entire ACL structure */
        uint32 num_aces; /* number of Access Control Entries */

        SEC_ACE *ace;

} SEC_ACL;

typedef struct security_descriptor_info
{
        uint16 revision; /* 0x0001 */
        uint16 type;     /* SEC_DESC_xxxx flags */

        uint32 off_owner_sid; /* offset to owner sid */
        uint32 off_grp_sid  ; /* offset to group sid */
        uint32 off_sacl     ; /* offset to system list of permissions */
        uint32 off_dacl     ; /* offset to list of permissions */

        SEC_ACL *dacl; /* user ACL */
        SEC_ACL *sacl; /* system ACL */
        DOM_SID *owner_sid; 
        DOM_SID *grp_sid;

} SEC_DESC;

/* End of stuff from rpc_secdesc.h */


/* From pstring.h */

#define PSTRING_LEN 1024
#define FSTRING_LEN 256

typedef char pstring[PSTRING_LEN];
typedef char fstring[FSTRING_LEN];

/* End of stuff from pstring.h */

/* From reg_objects.h */

typedef struct _REGISTRY_VALUE {
        fstring         valuename;
        uint16          type;
        /* this should be encapsulated in an RPC_DATA_BLOB */
        uint32          size;   /* in bytes */
        uint8           *data_p;
} REGISTRY_VALUE;

/* container for registry values */
typedef struct {
        void      *ctx;
        uint32          num_values;
        REGISTRY_VALUE  **values;
} REGVAL_CTR;

/* container for registry subkey names */
typedef struct {
        void    *ctx;
        uint32          num_subkeys;
        char            **subkeys;
} REGSUBKEY_CTR;

/* represent a registry key with all its subkeys and values */
struct _regobj_key;

typedef struct _regobj_key {
        void *ctx;

        char *name;

        REGVAL_CTR values;
        REGSUBKEY_CTR subkeys;
} REGOBJ_KEY;

/* End of stuff from reg_objects.h */

/* From rpc_secdes.h */

#define SEC_DESC_DACL_PRESENT           0x0004
#define SEC_DESC_SACL_PRESENT           0x0010
#define  SEC_DESC_HEADER_SIZE (2 * sizeof(uint16) + 4 * sizeof(uint32))
   /* thanks for Jim McDonough <jmcd@us.ibm.com> */
#define SEC_ACE_OBJECT_PRESENT        0x00000001 
#define SEC_ACE_OBJECT_INHERITED_PRESENT 0x00000002

#define SEC_ACE_TYPE_ACCESS_ALLOWED_OBJECT      0x5
#define SEC_ACE_TYPE_ACCESS_DENIED_OBJECT       0x6
#define SEC_ACE_TYPE_SYSTEM_AUDIT_OBJECT        0x7
#define SEC_ACE_TYPE_SYSTEM_ALARM_OBJECT        0x8

/* End of stuff from rpc_secdes.h */

/* From rpc_parse/parse_misc.c */

bool smb_io_uuid(const char *desc, struct uuid *uuid, 
                 prs_struct *ps, int depth);
bool smb_io_time(const char *desc, NTTIME *nttime, prs_struct *ps, int depth);
bool smb_io_dom_sid(const char *desc, DOM_SID *sid, prs_struct *ps, int depth);

/* End of stuff from rpc_parse/parse_misc.c */

/* From lib/util_sid.c */

size_t sid_size(const DOM_SID *sid);
int sid_compare_auth(const DOM_SID *sid1, const DOM_SID *sid2);
int sid_compare(const DOM_SID *sid1, const DOM_SID *sid2);
bool sid_equal(const DOM_SID *sid1, const DOM_SID *sid2);

/* End of stuff from lib/util_sid.c */

/* From lib/secace.c */

bool sec_ace_object(uint8 type);

/* End of stuff from lib/secace.c */

/* From rpc_parse/parse_sec.c */

bool sec_io_access(const char *desc, SEC_ACCESS *t, prs_struct *ps, int depth);
bool sec_io_ace(const char *desc, SEC_ACE *psa, prs_struct *ps, int depth);
bool sec_io_acl(const char *desc, SEC_ACL **ppsa, prs_struct *ps, int depth);
bool sec_io_desc(const char *desc, SEC_DESC **ppsd, prs_struct *ps, int depth);

/* End of stuff from rpc_parse/parse_sec.c */

/* From lib/secace.c */

bool sec_ace_equal(SEC_ACE *s1, SEC_ACE *s2);

/* End of stuff from lib/secace.c */

/* From lib/secacl.c */

bool sec_acl_equal(SEC_ACL *s1, SEC_ACL *s2);

/* End of stuff from lib/secacl.c */

/* From lib/secdesc.c */

bool sec_desc_equal(SEC_DESC *s1, SEC_DESC *s2);

/* End of stuff from lib/secdesc.c */