2 Unix SMB/Netbios implementation.
4 Samba utility functions
5 Copyright (C) Luke Leighton 1996 - 1997 Paul Ashton 1997
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 extern int DEBUGLEVEL;
27 /*******************************************************************
28 reads or writes a UTIME type.
29 ********************************************************************/
30 char* smb_io_utime(BOOL io, UTIME *t, char *q, char *base, int align, int depth)
32 if (t == NULL) return NULL;
34 DEBUG(5,("%s%04x smb_io_utime\n", tab_depth(depth), PTR_DIFF(q, base)));
37 q = align_offset(q, base, align);
39 DBG_RW_IVAL ("time", depth, base, io, q, t->time); q += 4;
44 /*******************************************************************
45 reads or writes an NTTIME structure.
46 ********************************************************************/
47 char* smb_io_time(BOOL io, NTTIME *nttime, char *q, char *base, int align, int depth)
49 if (nttime == NULL) return NULL;
51 DEBUG(5,("%s%04x smb_io_time\n", tab_depth(depth), PTR_DIFF(q, base)));
54 q = align_offset(q, base, align);
56 DBG_RW_IVAL("low ", depth, base, io, q, nttime->low ); q += 4; /* low part */
57 DBG_RW_IVAL("high", depth, base, io, q, nttime->high); q += 4; /* high part */
62 /*******************************************************************
63 reads or writes a DOM_SID structure.
64 ********************************************************************/
65 char* smb_io_dom_sid(BOOL io, DOM_SID *sid, char *q, char *base, int align, int depth)
69 if (sid == NULL) return NULL;
71 DEBUG(5,("%s%04x smb_io_dom_sid\n", tab_depth(depth), PTR_DIFF(q, base)));
74 DBG_RW_IVAL("num_auths ", depth, base, io, q, sid->num_auths); q += 4;
75 DBG_RW_CVAL("sid_no ", depth, base, io, q, sid->sid_no); q++;
76 DBG_RW_CVAL("num_auths ", depth, base, io, q, sid->num_auths); q++;
78 for (i = 0; i < 6; i++)
81 sprintf(tmp, "id_auth[%d] ", i);
82 DBG_RW_CVAL(tmp, depth, base, io, q, sid->id_auth[i]); q++;
85 /* oops! XXXX should really issue a warning here... */
86 if (sid->num_auths > MAXSUBAUTHS) sid->num_auths = MAXSUBAUTHS;
88 DBG_RW_PIVAL("num_auths ", depth, base, io, q, sid->sub_auths, sid->num_auths); q += sid->num_auths * 4;
93 /*******************************************************************
94 reads or writes a UNIHDR structure.
95 ********************************************************************/
96 char* smb_io_unihdr(BOOL io, UNIHDR *hdr, char *q, char *base, int align, int depth)
98 if (hdr == NULL) return NULL;
100 DEBUG(5,("%s%04x smb_io_unihdr\n", tab_depth(depth), PTR_DIFF(q, base)));
103 /* should be value 4, so enforce it. */
106 q = align_offset(q, base, align);
108 DBG_RW_IVAL("uni_max_len", depth, base, io, q, hdr->uni_max_len); q += 4;
109 DBG_RW_IVAL("uni_str_len", depth, base, io, q, hdr->uni_str_len); q += 4;
110 DBG_RW_IVAL("undoc ", depth, base, io, q, hdr->undoc ); q += 4;
115 /*******************************************************************
116 reads or writes a UNIHDR2 structure.
117 ********************************************************************/
118 char* smb_io_unihdr2(BOOL io, UNIHDR2 *hdr2, char *q, char *base, int align, int depth)
120 if (hdr2 == NULL) return NULL;
122 DEBUG(5,("%s%04x smb_io_unihdr2\n", tab_depth(depth), PTR_DIFF(q, base)));
125 q = align_offset(q, base, align);
127 q = smb_io_unihdr(io, &(hdr2->unihdr), q, base, align, depth);
128 DBG_RW_IVAL("undoc_buffer", depth, base, io, q, hdr2->undoc_buffer); q += 4;
133 /*******************************************************************
134 reads or writes a UNISTR structure.
135 XXXX NOTE: UNISTR structures NEED to be null-terminated.
136 ********************************************************************/
137 char* smb_io_unistr(BOOL io, UNISTR *uni, char *q, char *base, int align, int depth)
139 if (uni == NULL) return NULL;
141 DEBUG(5,("%s%04x smb_io_unistr\n", tab_depth(depth), PTR_DIFF(q, base)));
144 q = align_offset(q, base, align);
148 /* io True indicates read _from_ the SMB buffer into the string */
149 q += 2 * unistrcpy((char*)uni->buffer, q);
153 /* io True indicates copy _from_ the string into SMB buffer */
154 q += 2 * unistrcpy(q, (char*)uni->buffer);
159 /*******************************************************************
160 reads or writes a UNISTR2 structure.
161 XXXX NOTE: UNISTR2 structures need NOT be null-terminated.
162 the uni_str_len member tells you how long the string is;
163 the uni_max_len member tells you how large the buffer is.
164 ********************************************************************/
165 char* smb_io_unistr2(BOOL io, UNISTR2 *uni2, char *q, char *base, int align, int depth)
167 if (uni2 == NULL) return NULL;
169 DEBUG(5,("%s%04x smb_io_unistr2\n", tab_depth(depth), PTR_DIFF(q, base)));
172 q = align_offset(q, base, align);
174 /* should be value 0, so enforce it. */
177 DBG_RW_IVAL("uni_max_len", depth, base, io, q, uni2->uni_max_len); q += 4;
178 DBG_RW_IVAL("undoc ", depth, base, io, q, uni2->undoc ); q += 4;
179 DBG_RW_IVAL("uni_str_len", depth, base, io, q, uni2->uni_str_len); q += 4;
181 /* oops! XXXX maybe issue a warning that this is happening... */
182 if (uni2->uni_max_len > MAX_UNISTRLEN) uni2->uni_max_len = MAX_UNISTRLEN;
183 if (uni2->uni_str_len > MAX_UNISTRLEN) uni2->uni_str_len = MAX_UNISTRLEN;
185 /* buffer advanced by indicated length of string
186 NOT by searching for null-termination */
187 DBG_RW_PSVAL("buffer ", depth, base, io, q, uni2->buffer, uni2->uni_max_len); q += uni2->uni_max_len * 2;
192 /*******************************************************************
193 reads or writes a DOM_SID2 structure.
194 ********************************************************************/
195 char* smb_io_dom_sid2(BOOL io, DOM_SID2 *sid2, char *q, char *base, int align, int depth)
197 if (sid2 == NULL) return NULL;
199 DEBUG(5,("%s%04x smb_io_dom_sid2\n", tab_depth(depth), PTR_DIFF(q, base)));
202 q = align_offset(q, base, align);
204 /* should be value 5, so enforce it */
207 /* should be value 0, so enforce it */
210 DBG_RW_IVAL("type ", depth, base, io, q, sid2->type ); q += 4;
211 DBG_RW_IVAL("undoc", depth, base, io, q, sid2->undoc); q += 4;
213 q = smb_io_unihdr2(io, &(sid2->hdr), q, base, align, depth);
214 q = smb_io_unistr (io, &(sid2->str), q, base, align, depth);
219 /*******************************************************************
220 reads or writes a DOM_RID2 structure.
221 ********************************************************************/
222 char* smb_io_dom_rid2(BOOL io, DOM_RID2 *rid2, char *q, char *base, int align, int depth)
224 if (rid2 == NULL) return NULL;
226 DEBUG(5,("%s%04x smb_io_dom_rid2\n", tab_depth(depth), PTR_DIFF(q, base)));
229 q = align_offset(q, base, align);
231 /* should be value 5, so enforce it */
234 /* should be value 5, so enforce it */
237 DBG_RW_IVAL("type ", depth, base, io, q, rid2->type); q += 4;
238 DBG_RW_IVAL("undoc ", depth, base, io, q, rid2->undoc ); q += 4;
239 DBG_RW_IVAL("rid ", depth, base, io, q, rid2->rid ); q += 4;
240 DBG_RW_IVAL("rid_idx", depth, base, io, q, rid2->rid_idx ); q += 4;
245 /*******************************************************************
246 reads or writes a DOM_LOG_INFO structure.
247 ********************************************************************/
248 char* smb_io_log_info(BOOL io, DOM_LOG_INFO *log, char *q, char *base, int align, int depth)
250 if (log == NULL) return NULL;
252 DEBUG(5,("%s%04x smb_io_log_info\n", tab_depth(depth), PTR_DIFF(q, base)));
255 q = align_offset(q, base, align);
257 DBG_RW_IVAL("undoc_buffer", depth, base, io, q, log->undoc_buffer); q += 4;
259 q = smb_io_unistr2(io, &(log->uni_logon_srv), q, base, align, depth);
260 q = smb_io_unistr2(io, &(log->uni_acct_name), q, base, align, depth);
262 DBG_RW_SVAL("sec_chan", depth, base, io, q, log->sec_chan); q += 2;
264 q = smb_io_unistr2(io, &(log->uni_comp_name), q, base, align, depth);
269 /*******************************************************************
270 reads or writes a DOM_CHAL structure.
271 ********************************************************************/
272 char* smb_io_chal(BOOL io, DOM_CHAL *chal, char *q, char *base, int align, int depth)
274 if (chal == NULL) return NULL;
276 DEBUG(5,("%s%04x smb_io_chal\n", tab_depth(depth), PTR_DIFF(q, base)));
279 q = align_offset(q, base, align);
281 DBG_RW_IVAL("data[0]", depth, base, io, q, chal->data[0]); q += 4;
282 DBG_RW_IVAL("data[1]", depth, base, io, q, chal->data[1]); q += 4;
284 DBG_RW_PCVAL("data", depth, base, io, q, chal->data, 8); q += 8;
289 /*******************************************************************
290 reads or writes a DOM_CRED structure.
291 ********************************************************************/
292 char* smb_io_cred(BOOL io, DOM_CRED *cred, char *q, char *base, int align, int depth)
294 if (cred == NULL) return NULL;
296 DEBUG(5,("%s%04x smb_io_cred\n", tab_depth(depth), PTR_DIFF(q, base)));
299 q = align_offset(q, base, align);
301 q = smb_io_chal (io, &(cred->challenge), q, base, align, depth);
302 q = smb_io_utime(io, &(cred->timestamp), q, base, align, depth);
307 /*******************************************************************
308 reads or writes a DOM_CLNT_INFO structure.
309 ********************************************************************/
310 char* smb_io_clnt_info(BOOL io, DOM_CLNT_INFO *clnt, char *q, char *base, int align, int depth)
312 if (clnt == NULL) return NULL;
314 DEBUG(5,("%s%04x smb_io_clnt_info\n", tab_depth(depth), PTR_DIFF(q, base)));
317 q = align_offset(q, base, align);
319 q = smb_io_log_info(io, &(clnt->login), q, base, align, depth);
320 q = smb_io_cred (io, &(clnt->cred ), q, base, align, depth);
325 /*******************************************************************
326 reads or writes a DOM_LOGON_ID structure.
327 ********************************************************************/
328 char* smb_io_logon_id(BOOL io, DOM_LOGON_ID *log, char *q, char *base, int align, int depth)
330 if (log == NULL) return NULL;
332 DEBUG(5,("%s%04x smb_io_logon_id\n", tab_depth(depth), PTR_DIFF(q, base)));
335 q = align_offset(q, base, align);
337 DBG_RW_IVAL("low ", depth, base, io, q, log->low ); q += 4;
338 DBG_RW_IVAL("high", depth, base, io, q, log->high); q += 4;
343 /*******************************************************************
344 reads or writes an ARC4_OWF structure.
345 ********************************************************************/
346 char* smb_io_arc4_owf(BOOL io, ARC4_OWF *hash, char *q, char *base, int align, int depth)
348 if (hash == NULL) return NULL;
350 DEBUG(5,("%s%04x smb_io_arc4_owf\n", tab_depth(depth), PTR_DIFF(q, base)));
353 q = align_offset(q, base, align);
355 DBG_RW_PCVAL("data", depth, base, io, q, hash->data, 16); q += 16;
360 /*******************************************************************
361 reads or writes an DOM_ID_INFO_1 structure.
362 ********************************************************************/
363 char* smb_io_id_info1(BOOL io, DOM_ID_INFO_1 *id, char *q, char *base, int align, int depth)
365 if (id == NULL) return NULL;
367 DEBUG(5,("%s%04x smb_io_id_info1\n", tab_depth(depth), PTR_DIFF(q, base)));
370 q = align_offset(q, base, align);
372 q = smb_io_unihdr(io, &(id->hdr_domain_name ), q, base, align, depth);
374 DBG_RW_IVAL("param", depth, base, io, q, id->param); q += 4;
375 q = smb_io_logon_id(io, &(id->logon_id), q, base, align, depth);
377 q = smb_io_unihdr(io, &(id->hdr_user_name ), q, base, align, depth);
378 q = smb_io_unihdr(io, &(id->hdr_workgroup_name), q, base, align, depth);
380 q = smb_io_arc4_owf(io, &(id->arc4_lm_owf), q, base, align, depth);
381 q = smb_io_arc4_owf(io, &(id->arc4_nt_owf), q, base, align, depth);
383 q = smb_io_unistr2(io, &(id->uni_domain_name ), q, base, align, depth);
384 q = smb_io_unistr2(io, &(id->uni_user_name ), q, base, align, depth);
385 q = smb_io_unistr2(io, &(id->uni_workgroup_name), q, base, align, depth);
390 /*******************************************************************
391 reads or writes a DOM_SAM_INFO structure.
392 ********************************************************************/
393 char* smb_io_sam_info(BOOL io, DOM_SAM_INFO *sam, char *q, char *base, int align, int depth)
395 if (sam == NULL) return NULL;
397 DEBUG(5,("%s%04x smb_io_sam_info\n", tab_depth(depth), PTR_DIFF(q, base)));
400 q = align_offset(q, base, align);
402 q = smb_io_clnt_info(io, &(sam->client ), q, base, align, depth);
403 q = smb_io_cred (io, &(sam->rtn_cred), q, base, align, depth);
405 DBG_RW_IVAL("logon_level", depth, base, io, q, sam->logon_level); q += 4;
406 DBG_RW_SVAL("auth_level ", depth, base, io, q, sam->auth_level ); q += 4;
408 switch (sam->auth_level)
412 q = smb_io_id_info1(io, &(sam->auth.id1), q, base, align, depth);
424 /*******************************************************************
425 reads or writes a DOM_GID structure.
426 ********************************************************************/
427 char* smb_io_gid(BOOL io, DOM_GID *gid, char *q, char *base, int align, int depth)
429 if (gid == NULL) return NULL;
431 DEBUG(5,("%s%04x smb_io_gid\n", tab_depth(depth), PTR_DIFF(q, base)));
434 q = align_offset(q, base, align);
436 DBG_RW_IVAL("gid ", depth, base, io, q, gid->gid ); q += 4;
437 DBG_RW_IVAL("attr", depth, base, io, q, gid->attr); q += 4;
442 /*******************************************************************
443 reads or writes an RPC_HDR structure.
444 ********************************************************************/
445 char* smb_io_rpc_hdr(BOOL io, RPC_HDR *rpc, char *q, char *base, int align, int depth)
447 if (rpc == NULL) return NULL;
449 DEBUG(5,("%s%04x smb_io_rpc_hdr\n", tab_depth(depth), PTR_DIFF(q, base)));
452 /* reserved should be zero: enforce it */
455 DBG_RW_CVAL("major ", depth, base, io, q, rpc->major); q++;
456 DBG_RW_CVAL("minor ", depth, base, io, q, rpc->minor); q++;
457 DBG_RW_CVAL("pkt_type ", depth, base, io, q, rpc->pkt_type); q++;
458 DBG_RW_CVAL("frag ", depth, base, io, q, rpc->frag); q++;
459 DBG_RW_IVAL("pack_type ", depth, base, io, q, rpc->pack_type); q += 4;
460 DBG_RW_SVAL("frag_len ", depth, base, io, q, rpc->frag_len); q += 2;
461 DBG_RW_SVAL("auth_len ", depth, base, io, q, rpc->auth_len); q += 2;
462 DBG_RW_IVAL("call_id ", depth, base, io, q, rpc->call_id); q += 4;
463 DBG_RW_IVAL("alloc_hint", depth, base, io, q, rpc->alloc_hint); q += 4;
464 DBG_RW_CVAL("context_id", depth, base, io, q, rpc->context_id); q++;
465 DBG_RW_CVAL("reserved ", depth, base, io, q, rpc->reserved); q++;
470 /*******************************************************************
471 reads or writes an LSA_POL_HND structure.
472 ********************************************************************/
473 char* smb_io_pol_hnd(BOOL io, LSA_POL_HND *pol, char *q, char *base, int align, int depth)
475 if (pol == NULL) return NULL;
477 DEBUG(5,("%s%04x smb_io_pol_hnd\n", tab_depth(depth), PTR_DIFF(q, base)));
480 q = align_offset(q, base, align);
482 DBG_RW_PCVAL("data", depth, base, io, q, pol->data, POL_HND_SIZE); q += POL_HND_SIZE;
487 /*******************************************************************
488 reads or writes a dom query structure.
489 ********************************************************************/
490 char* smb_io_dom_query_3(BOOL io, DOM_QUERY_3 *d_q, char *q, char *base, int align, int depth)
492 return smb_io_dom_query(io, d_q, q, base, align, depth);
495 /*******************************************************************
496 reads or writes a dom query structure.
497 ********************************************************************/
498 char* smb_io_dom_query_5(BOOL io, DOM_QUERY_3 *d_q, char *q, char *base, int align, int depth)
500 return smb_io_dom_query(io, d_q, q, base, align, depth);
503 /*******************************************************************
504 reads or writes a dom query structure.
505 ********************************************************************/
506 char* smb_io_dom_query(BOOL io, DOM_QUERY *d_q, char *q, char *base, int align, int depth)
508 if (d_q == NULL) return NULL;
510 DEBUG(5,("%s%04x smb_io_dom_query\n", tab_depth(depth), PTR_DIFF(q, base)));
513 q = align_offset(q, base, align);
515 DBG_RW_SVAL("uni_dom_max_len", depth, base, io, q, d_q->uni_dom_max_len); q += 2; /* domain name string length * 2 */
516 DBG_RW_SVAL("uni_dom_str_len", depth, base, io, q, d_q->uni_dom_str_len); q += 2; /* domain name string length * 2 */
518 DBG_RW_IVAL("buffer_dom_name", depth, base, io, q, d_q->buffer_dom_name); q += 4; /* undocumented domain name string buffer pointer */
519 DBG_RW_IVAL("buffer_dom_sid ", depth, base, io, q, d_q->buffer_dom_sid ); q += 4; /* undocumented domain SID string buffer pointer */
521 if (d_q->buffer_dom_name != 0)
523 q = smb_io_unistr2(io, &(d_q->uni_domain_name), q, base, align, depth); /* domain name (unicode string) */
525 if (d_q->buffer_dom_sid != 0)
527 q = smb_io_dom_sid(io, &(d_q->dom_sid), q, base, align, depth); /* domain SID */
533 /*******************************************************************
534 reads or writes a DOM_R_REF structure.
535 ********************************************************************/
536 char* smb_io_dom_r_ref(BOOL io, DOM_R_REF *r_r, char *q, char *base, int align, int depth)
540 DEBUG(5,("%s%04x smb_io_dom_r_ref\n", tab_depth(depth), PTR_DIFF(q, base)));
543 if (r_r == NULL) return NULL;
545 q = align_offset(q, base, align);
547 DBG_RW_IVAL("undoc_buffer ", depth, base, io, q, r_r->undoc_buffer); q += 4; /* undocumented buffer pointer. */
548 DBG_RW_IVAL("num_ref_doms_1 ", depth, base, io, q, r_r->num_ref_doms_1); q += 4; /* num referenced domains? */
549 DBG_RW_IVAL("buffer_dom_name", depth, base, io, q, r_r->buffer_dom_name); q += 4; /* undocumented domain name buffer pointer. */
550 DBG_RW_IVAL("max_entries ", depth, base, io, q, r_r->max_entries); q += 4; /* 32 - max number of entries */
551 DBG_RW_IVAL("num_ref_doms_2 ", depth, base, io, q, r_r->num_ref_doms_2); q += 4; /* 4 - num referenced domains? */
553 q = smb_io_unihdr2(io, &(r_r->hdr_dom_name), q, base, align, depth); /* domain name unicode string header */
555 for (i = 0; i < r_r->num_ref_doms_1-1; i++)
557 q = smb_io_unihdr2(io, &(r_r->hdr_ref_dom[i]), q, base, align, depth);
560 q = smb_io_unistr(io, &(r_r->uni_dom_name), q, base, align, depth); /* domain name unicode string */
562 for (i = 0; i < r_r->num_ref_doms_2; i++)
564 q = smb_io_dom_sid(io, &(r_r->ref_dom[i]), q, base, align, depth); /* referenced domain SIDs */
569 /*******************************************************************
570 reads or writes a DOM_NAME structure.
571 ********************************************************************/
572 char* smb_io_dom_name(BOOL io, DOM_NAME *name, char *q, char *base, int align, int depth)
574 if (name == NULL) return NULL;
576 DEBUG(5,("%s%04x smb_io_dom_name\n", tab_depth(depth), PTR_DIFF(q, base)));
579 q = align_offset(q, base, align);
581 DBG_RW_IVAL("uni_str_len", depth, base, io, q, name->uni_str_len); q += 4;
583 /* don't know if len is specified by uni_str_len member... */
584 /* assume unicode string is unicode-null-terminated, instead */
586 q = smb_io_unistr(io, &(name->str), q, base, align, depth);
592 /*******************************************************************
593 reads or writes a structure.
594 ********************************************************************/
595 char* smb_io_neg_flags(BOOL io, NEG_FLAGS *neg, char *q, char *base, int align, int depth)
597 if (neg == NULL) return NULL;
599 DEBUG(5,("%s%04x smb_io_neg_flags\n", tab_depth(depth), PTR_DIFF(q, base)));
602 q = align_offset(q, base, align);
604 DBG_RW_IVAL("neg_flags", depth, base, io, q, neg->neg_flags); q += 4;
611 /*******************************************************************
612 reads or writes a structure.
613 ********************************************************************/
614 char* smb_io_(BOOL io, *, char *q, char *base, int align, int depth)
616 if (== NULL) return NULL;
618 q = align_offset(q, base, align);
620 DBG_RW_IVAL("", depth, base, io, q, ); q += 4;