2 * Unix SMB/CIFS implementation.
3 * RPC Pipe client / server routines
4 * Copyright (C) Andrew Tridgell 1992-1997,
5 * Copyright (C) Luke Kenneth Casson Leighton 1996-1997,
6 * Copyright (C) Paul Ashton 1997.
7 * Copyright (C) Gerald (Jerry) Carter 2005
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, see <http://www.gnu.org/licenses/>.
26 #define DBGC_CLASS DBGC_RPC_PARSE
28 /*******************************************************************
29 Reads or writes an NTTIME structure.
30 ********************************************************************/
32 bool smb_io_time(const char *desc, NTTIME *nttime, prs_struct *ps, int depth)
38 prs_debug(ps, depth, desc, "smb_io_time");
44 if (MARSHALLING(ps)) {
45 low = *nttime & 0xFFFFFFFF;
49 if(!prs_uint32("low ", ps, depth, &low)) /* low part */
51 if(!prs_uint32("high", ps, depth, &high)) /* high part */
54 if (UNMARSHALLING(ps)) {
55 *nttime = (((uint64_t)high << 32) + low);
61 /*******************************************************************
62 Reads or writes an NTTIME structure.
63 ********************************************************************/
65 bool smb_io_nttime(const char *desc, prs_struct *ps, int depth, NTTIME *nttime)
67 return smb_io_time( desc, nttime, ps, depth );
70 /*******************************************************************
71 ********************************************************************/
73 bool smb_io_system_time(const char *desc, prs_struct *ps, int depth, SYSTEMTIME *systime)
75 if(!prs_uint16("year", ps, depth, &systime->year))
77 if(!prs_uint16("month", ps, depth, &systime->month))
79 if(!prs_uint16("dayofweek", ps, depth, &systime->dayofweek))
81 if(!prs_uint16("day", ps, depth, &systime->day))
83 if(!prs_uint16("hour", ps, depth, &systime->hour))
85 if(!prs_uint16("minute", ps, depth, &systime->minute))
87 if(!prs_uint16("second", ps, depth, &systime->second))
89 if(!prs_uint16("milliseconds", ps, depth, &systime->milliseconds))
95 /*******************************************************************
96 ********************************************************************/
98 bool make_systemtime(SYSTEMTIME *systime, struct tm *unixtime)
100 systime->year=unixtime->tm_year+1900;
101 systime->month=unixtime->tm_mon+1;
102 systime->dayofweek=unixtime->tm_wday;
103 systime->day=unixtime->tm_mday;
104 systime->hour=unixtime->tm_hour;
105 systime->minute=unixtime->tm_min;
106 systime->second=unixtime->tm_sec;
107 systime->milliseconds=0;
112 /*******************************************************************
113 Reads or writes a DOM_SID structure.
114 ********************************************************************/
116 bool smb_io_dom_sid(const char *desc, DOM_SID *sid, prs_struct *ps, int depth)
123 prs_debug(ps, depth, desc, "smb_io_dom_sid");
126 if(!prs_uint8 ("sid_rev_num", ps, depth, &sid->sid_rev_num))
129 if(!prs_uint8 ("num_auths ", ps, depth, (uint8 *)&sid->num_auths))
132 for (i = 0; i < 6; i++)
135 slprintf(tmp, sizeof(tmp) - 1, "id_auth[%d] ", i);
136 if(!prs_uint8 (tmp, ps, depth, &sid->id_auth[i]))
140 /* oops! XXXX should really issue a warning here... */
141 if (sid->num_auths > MAXSUBAUTHS)
142 sid->num_auths = MAXSUBAUTHS;
144 if(!prs_uint32s(False, "sub_auths ", ps, depth, sid->sub_auths, sid->num_auths))
150 /*******************************************************************
151 Reads or writes a struct GUID
152 ********************************************************************/
154 bool smb_io_uuid(const char *desc, struct GUID *uuid,
155 prs_struct *ps, int depth)
160 prs_debug(ps, depth, desc, "smb_io_uuid");
163 if(!prs_uint32 ("data ", ps, depth, &uuid->time_low))
165 if(!prs_uint16 ("data ", ps, depth, &uuid->time_mid))
167 if(!prs_uint16 ("data ", ps, depth, &uuid->time_hi_and_version))
170 if(!prs_uint8s (False, "data ", ps, depth, uuid->clock_seq, sizeof(uuid->clock_seq)))
172 if(!prs_uint8s (False, "data ", ps, depth, uuid->node, sizeof(uuid->node)))
178 /*******************************************************************
179 Inits a UNISTR structure.
180 ********************************************************************/
182 void init_unistr(UNISTR *str, const char *buf)
191 len = rpcstr_push_talloc(talloc_tos(), &str->buffer, buf);
192 if (len == (size_t)-1) {
197 /*******************************************************************
198 reads or writes a UNISTR structure.
199 XXXX NOTE: UNISTR structures NEED to be null-terminated.
200 ********************************************************************/
202 bool smb_io_unistr(const char *desc, UNISTR *uni, prs_struct *ps, int depth)
207 prs_debug(ps, depth, desc, "smb_io_unistr");
210 if(!prs_unistr("unistr", ps, depth, uni))
216 /*******************************************************************
217 reads or writes a BUFFER5 structure.
218 the buf_len member tells you how large the buffer is.
219 ********************************************************************/
220 bool smb_io_buffer5(const char *desc, BUFFER5 *buf5, prs_struct *ps, int depth)
222 prs_debug(ps, depth, desc, "smb_io_buffer5");
225 if (buf5 == NULL) return False;
229 if(!prs_uint32("buf_len", ps, depth, &buf5->buf_len))
233 if(!prs_buffer5(True, "buffer" , ps, depth, buf5))
240 /*******************************************************************
241 creates a UNISTR2 structure: sets up the buffer, too
242 ********************************************************************/
244 void init_buf_unistr2(UNISTR2 *str, uint32 *ptr, const char *buf)
248 init_unistr2(str, buf, UNI_STR_TERMINATE);
251 init_unistr2(str, NULL, UNI_FLAGS_NONE);
256 /*******************************************************************
257 Copies a UNISTR2 structure.
258 ********************************************************************/
260 void copy_unistr2(UNISTR2 *str, const UNISTR2 *from)
262 if (from->buffer == NULL) {
267 SMB_ASSERT(from->uni_max_len >= from->uni_str_len);
269 str->uni_max_len = from->uni_max_len;
270 str->offset = from->offset;
271 str->uni_str_len = from->uni_str_len;
273 /* the string buffer is allocated to the maximum size
274 (the the length of the source string) to prevent
275 reallocation of memory. */
276 if (str->buffer == NULL) {
277 if (str->uni_max_len) {
278 str->buffer = (uint16 *)TALLOC_ZERO_ARRAY(talloc_tos(), uint16, str->uni_max_len);
279 if ((str->buffer == NULL)) {
280 smb_panic("copy_unistr2: talloc fail");
283 /* copy the string */
284 memcpy(str->buffer, from->buffer, str->uni_max_len*sizeof(uint16));
291 /*******************************************************************
292 Inits a UNISTR2 structure.
293 ********************************************************************/
295 void init_unistr2(UNISTR2 *str, const char *buf, enum unistr2_term_codes flags)
298 uint32 num_chars = 0;
301 /* We always null terminate the copy. */
302 len = strlen(buf) + 1;
303 if ( flags == UNI_STR_DBLTERMINATE )
307 if (buf == NULL || len == 0) {
308 /* no buffer -- nothing to do */
309 str->uni_max_len = 0;
311 str->uni_str_len = 0;
317 str->buffer = TALLOC_ZERO_ARRAY(talloc_tos(), uint16, len);
318 if (str->buffer == NULL) {
319 smb_panic("init_unistr2: malloc fail");
323 /* Ensure len is the length in *bytes* */
324 len *= sizeof(uint16);
327 * The UNISTR2 must be initialized !!!
331 rpcstr_push((char *)str->buffer, buf, len, STR_TERMINATE);
332 num_chars = strlen_w(str->buffer);
333 if (flags == UNI_STR_TERMINATE || flags == UNI_MAXLEN_TERMINATE) {
336 if ( flags == UNI_STR_DBLTERMINATE )
340 str->uni_max_len = num_chars;
342 str->uni_str_len = num_chars;
343 if ( num_chars && ((flags == UNI_MAXLEN_TERMINATE) || (flags == UNI_BROKEN_NON_NULL)) )
348 * Inits a UNISTR2 structure.
349 * @param ctx talloc context to allocate string on
350 * @param str pointer to string to create
351 * @param buf UCS2 null-terminated buffer to init from
354 void init_unistr2_w(TALLOC_CTX *ctx, UNISTR2 *str, const smb_ucs2_t *buf)
356 uint32 len = buf ? strlen_w(buf) : 0;
360 /* set up string lengths. */
361 str->uni_max_len = len;
363 str->uni_str_len = len;
366 str->buffer = TALLOC_ZERO_ARRAY(ctx, uint16, len + 1);
367 if (str->buffer == NULL) {
368 smb_panic("init_unistr2_w: talloc fail");
376 * don't move this test above ! The UNISTR2 must be initialized !!!
382 /* Yes, this is a strncpy( foo, bar, strlen(bar)) - but as
383 long as the buffer above is talloc()ed correctly then this
384 is the correct thing to do */
386 strncpy_w(str->buffer, buf, len + 1);
390 /*******************************************************************
391 Inits a UNISTR2 structure from a UNISTR
392 ********************************************************************/
394 void init_unistr2_from_unistr(TALLOC_CTX *ctx, UNISTR2 *to, const UNISTR *from)
398 /* the destination UNISTR2 should never be NULL.
399 if it is it is a programming error */
401 /* if the source UNISTR is NULL, then zero out
402 the destination string and return */
404 if ((from == NULL) || (from->buffer == NULL))
407 /* get the length; UNISTR must be NULL terminated */
409 while ((from->buffer)[i]!='\0')
411 i++; /* one more to catch the terminating NULL */
412 /* is this necessary -- jerry? I need to think */
414 /* set up string lengths; uni_max_len is set to i+1
415 because we need to account for the final NULL termination */
420 /* allocate the space and copy the string buffer */
422 to->buffer = TALLOC_ZERO_ARRAY(ctx, uint16, i);
423 if (to->buffer == NULL)
424 smb_panic("init_unistr2_from_unistr: talloc fail");
425 memcpy(to->buffer, from->buffer, i*sizeof(uint16));
432 /*******************************************************************
433 Inits a UNISTR2 structure from a DATA_BLOB.
434 The length of the data_blob must count the bytes of the buffer.
435 Copies the blob data.
436 ********************************************************************/
438 void init_unistr2_from_datablob(UNISTR2 *str, DATA_BLOB *blob)
440 /* Allocs the unistring */
441 init_unistr2(str, NULL, UNI_FLAGS_NONE);
443 /* Sets the values */
444 str->uni_str_len = blob->length / sizeof(uint16);
445 str->uni_max_len = str->uni_str_len;
448 str->buffer = (uint16 *) memdup(blob->data, blob->length);
452 if ((str->buffer == NULL) && (blob->length > 0)) {
453 smb_panic("init_unistr2_from_datablob: malloc fail");
457 /*******************************************************************
458 UNISTR2* are a little different in that the pointer and the UNISTR2
459 are not necessarily read/written back to back. So we break it up
460 into 2 separate functions.
461 See SPOOL_USER_1 in include/rpc_spoolss.h for an example.
462 ********************************************************************/
464 bool prs_io_unistr2_p(const char *desc, prs_struct *ps, int depth, UNISTR2 **uni2)
468 /* caputure the pointer value to stream */
470 data_p = *uni2 ? 0xf000baaa : 0;
472 if ( !prs_uint32("ptr", ps, depth, &data_p ))
475 /* we're done if there is no data */
480 if (UNMARSHALLING(ps)) {
481 if ( !(*uni2 = PRS_ALLOC_MEM(ps, UNISTR2, 1)) )
488 /*******************************************************************
489 now read/write the actual UNISTR2. Memory for the UNISTR2 (but
490 not UNISTR2.buffer) has been allocated previously by prs_unistr2_p()
491 ********************************************************************/
493 bool prs_io_unistr2(const char *desc, prs_struct *ps, int depth, UNISTR2 *uni2 )
495 /* just return true if there is no pointer to deal with.
496 the memory must have been previously allocated on unmarshalling
497 by prs_unistr2_p() */
502 /* just pass off to smb_io_unstr2() passing the uni2 address as
503 the pointer (like you would expect) */
505 return smb_io_unistr2( desc, uni2, uni2 ? 1 : 0, ps, depth );
508 /*******************************************************************
509 Reads or writes a UNISTR2 structure.
510 XXXX NOTE: UNISTR2 structures need NOT be null-terminated.
511 the uni_str_len member tells you how long the string is;
512 the uni_max_len member tells you how large the buffer is.
513 ********************************************************************/
515 bool smb_io_unistr2(const char *desc, UNISTR2 *uni2, uint32 buffer, prs_struct *ps, int depth)
522 prs_debug(ps, depth, desc, "smb_io_unistr2");
528 if(!prs_uint32("uni_max_len", ps, depth, &uni2->uni_max_len))
530 if(!prs_uint32("offset ", ps, depth, &uni2->offset))
532 if(!prs_uint32("uni_str_len", ps, depth, &uni2->uni_str_len))
535 /* buffer advanced by indicated length of string
536 NOT by searching for null-termination */
537 if(!prs_unistr2(True, "buffer ", ps, depth, uni2))
542 prs_debug(ps, depth, desc, "smb_io_unistr2 - NULL");
544 memset((char *)uni2, '\0', sizeof(*uni2));
551 /*******************************************************************
552 Reads or writes an POLICY_HND structure.
553 ********************************************************************/
555 bool smb_io_pol_hnd(const char *desc, POLICY_HND *pol, prs_struct *ps, int depth)
560 prs_debug(ps, depth, desc, "smb_io_pol_hnd");
566 if(UNMARSHALLING(ps))
569 if (!prs_uint32("handle_type", ps, depth, &pol->handle_type))
571 if (!smb_io_uuid("uuid", (struct GUID*)&pol->uuid, ps, depth))
577 /*******************************************************************
579 ********************************************************************/
581 void init_unistr3(UNISTR3 *str, const char *buf)
585 str->str.buffer = NULL;
589 str->uni_str_len = strlen(buf) + 1;
591 if (str->uni_str_len) {
592 str->str.buffer = TALLOC_ZERO_ARRAY(talloc_tos(), uint16, str->uni_str_len);
593 if (str->str.buffer == NULL)
594 smb_panic("init_unistr3: malloc fail");
596 rpcstr_push((char *)str->str.buffer, buf, str->uni_str_len * sizeof(uint16), STR_TERMINATE);
598 str->str.buffer = NULL;
602 /*******************************************************************
603 Reads or writes a UNISTR3 structure.
604 ********************************************************************/
606 bool smb_io_unistr3(const char *desc, UNISTR3 *name, prs_struct *ps, int depth)
611 prs_debug(ps, depth, desc, "smb_io_unistr3");
617 if(!prs_uint32("uni_str_len", ps, depth, &name->uni_str_len))
620 /* we're done if there is no string */
622 if ( name->uni_str_len == 0 )
625 /* don't know if len is specified by uni_str_len member... */
626 /* assume unicode string is unicode-null-terminated, instead */
628 if(!prs_unistr3(True, "unistr", name, ps, depth))
634 /*******************************************************************
635 return the length of a UNISTR string.
636 ********************************************************************/
638 uint32 str_len_uni(UNISTR *source)
645 while (source->buffer[i])
651 /*******************************************************************
652 Verifies policy handle
653 ********************************************************************/
655 bool policy_handle_is_valid(const POLICY_HND *hnd)
659 ZERO_STRUCT(zero_pol);
660 return ((memcmp(&zero_pol, hnd, sizeof(POLICY_HND)) == 0) ? false : true );