2 Unix SMB/CIFS implementation.
4 manipulate nbt name structures
6 Copyright (C) Andrew Tridgell 2005
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
23 see rfc1002 for the detailed format of compressed names
27 #include "librpc/gen_ndr/ndr_nbt.h"
28 #include "librpc/gen_ndr/ndr_misc.h"
29 #include "system/locale.h"
30 #include "lib/util/util_net.h"
31 #include "libcli/nbt/libnbt.h"
34 decompress a 'compressed' name component
36 static bool decompress_name(char *name
, enum nbt_name_type
*type
)
39 for (i
=0;name
[2*i
];i
++) {
40 uint8_t c1
= name
[2*i
];
41 uint8_t c2
= name
[1+(2*i
)];
42 if (c1
< 'A' || c1
> 'P' ||
43 c2
< 'A' || c2
> 'P') {
46 name
[i
] = ((c1
-'A')<<4) | (c2
-'A');
50 *type
= (enum nbt_name_type
)(name
[15]);
54 *type
= NBT_NAME_CLIENT
;
57 /* trim trailing spaces */
58 for (;i
>0 && name
[i
-1]==' ';i
--) {
67 compress a name component
69 static uint8_t *compress_name(TALLOC_CTX
*mem_ctx
,
70 const uint8_t *name
, enum nbt_name_type type
)
76 if (strlen((const char *)name
) > 15) {
80 cname
= talloc_array(mem_ctx
, uint8_t, 33);
81 if (cname
== NULL
) return NULL
;
83 for (i
=0;name
[i
];i
++) {
84 cname
[2*i
] = 'A' + (name
[i
]>>4);
85 cname
[1+2*i
] = 'A' + (name
[i
]&0xF);
87 if (strcmp((const char *)name
, "*") == 0) {
93 cname
[2*i
] = 'A' + (pad_char
>>4);
94 cname
[1+2*i
] = 'A' + (pad_char
&0xF);
98 cname
[2*i
] = 'A' + (pad_char
>>4);
99 cname
[1+2*i
] = 'A' + (pad_char
&0xF);
107 pull a nbt name from the wire
109 _PUBLIC_
enum ndr_err_code
ndr_pull_nbt_name(struct ndr_pull
*ndr
, int ndr_flags
, struct nbt_name
*r
)
116 if (!(ndr_flags
& NDR_SCALARS
)) {
117 return NDR_ERR_SUCCESS
;
120 NDR_CHECK(ndr_pull_nbt_string(ndr
, ndr_flags
, &s
));
122 scope
= (uint8_t *)strchr(s
, '.');
125 r
->scope
= talloc_strdup(ndr
->current_mem_ctx
, (const char *)&scope
[1]);
126 NDR_ERR_HAVE_NO_MEMORY(r
->scope
);
131 cname
= discard_const_p(char, s
);
133 /* the first component is limited to 16 bytes in the DOS charset,
134 which is 32 in the 'compressed' form */
135 if (strlen(cname
) > 32) {
136 return ndr_pull_error(ndr
, NDR_ERR_STRING
,
137 "NBT NAME cname > 32");
140 /* decompress the first component */
141 ok
= decompress_name(cname
, &r
->type
);
143 return ndr_pull_error(ndr
, NDR_ERR_STRING
,
144 "NBT NAME failed to decompress");
147 r
->name
= talloc_strdup(ndr
->current_mem_ctx
, cname
);
148 NDR_ERR_HAVE_NO_MEMORY(r
->name
);
152 return NDR_ERR_SUCCESS
;
156 push a nbt name to the wire
158 _PUBLIC_
enum ndr_err_code
ndr_push_nbt_name(struct ndr_push
*ndr
, int ndr_flags
, const struct nbt_name
*r
)
160 uint8_t *cname
, *fullname
;
161 enum ndr_err_code ndr_err
;
163 if (!(ndr_flags
& NDR_SCALARS
)) {
164 return NDR_ERR_SUCCESS
;
167 if (strlen(r
->name
) > 15) {
168 return ndr_push_error(ndr
, NDR_ERR_STRING
,
169 "nbt_name longer as 15 chars: %s",
173 cname
= compress_name(ndr
, (const uint8_t *)r
->name
, r
->type
);
174 NDR_ERR_HAVE_NO_MEMORY(cname
);
177 fullname
= (uint8_t *)talloc_asprintf(ndr
, "%s.%s", cname
, r
->scope
);
178 NDR_ERR_HAVE_NO_MEMORY(fullname
);
184 ndr_err
= ndr_push_nbt_string(ndr
, ndr_flags
, (const char *)fullname
);
191 copy a nbt name structure
193 _PUBLIC_ NTSTATUS
nbt_name_dup(TALLOC_CTX
*mem_ctx
,
194 const struct nbt_name
*name
,
195 struct nbt_name
*newname
)
198 newname
->name
= talloc_strdup(mem_ctx
, newname
->name
);
199 NT_STATUS_HAVE_NO_MEMORY(newname
->name
);
200 newname
->scope
= talloc_strdup(mem_ctx
, newname
->scope
);
202 NT_STATUS_HAVE_NO_MEMORY(newname
->scope
);
208 push a nbt name into a blob
210 _PUBLIC_ NTSTATUS
nbt_name_to_blob(TALLOC_CTX
*mem_ctx
, DATA_BLOB
*blob
, struct nbt_name
*name
)
212 enum ndr_err_code ndr_err
;
214 ndr_err
= ndr_push_struct_blob(blob
, mem_ctx
, name
, (ndr_push_flags_fn_t
)ndr_push_nbt_name
);
215 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err
)) {
216 return ndr_map_error2ntstatus(ndr_err
);
223 pull a nbt name from a blob
225 _PUBLIC_ NTSTATUS
nbt_name_from_blob(TALLOC_CTX
*mem_ctx
, const DATA_BLOB
*blob
, struct nbt_name
*name
)
227 enum ndr_err_code ndr_err
;
229 ndr_err
= ndr_pull_struct_blob(blob
, mem_ctx
, name
,
230 (ndr_pull_flags_fn_t
)ndr_pull_nbt_name
);
231 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err
)) {
232 return ndr_map_error2ntstatus(ndr_err
);
240 choose a name to use when calling a server in a NBT session request.
241 we use heuristics to see if the name we have been given is a IP
242 address, or a too-long name. If it is then use *SMBSERVER, or a
245 _PUBLIC_
void nbt_choose_called_name(TALLOC_CTX
*mem_ctx
,
246 struct nbt_name
*n
, const char *name
, int type
)
251 if ((name
== NULL
) || is_ipaddress(name
)) {
252 n
->name
= "*SMBSERVER";
255 if (strlen(name
) > 15) {
256 const char *p
= strchr(name
, '.');
259 n
->name
= "*SMBSERVER";
262 s
= talloc_strndup(mem_ctx
, name
, PTR_DIFF(p
, name
));
263 n
->name
= talloc_strdup_upper(mem_ctx
, s
);
267 n
->name
= talloc_strdup_upper(mem_ctx
, name
);
272 escape a string into a form containing only a small set of characters,
273 the rest is hex encoded. This is similar to URL encoding
275 static const char *nbt_hex_encode(TALLOC_CTX
*mem_ctx
, const char *s
)
279 const char *valid_chars
= "_-.$@ ";
280 #define NBT_CHAR_ALLOW(c) (isalnum((unsigned char)c) || strchr(valid_chars, c))
282 for (len
=i
=0;s
[i
];i
++,len
++) {
283 if (!NBT_CHAR_ALLOW(s
[i
])) {
288 ret
= talloc_array(mem_ctx
, char, len
+1);
289 if (ret
== NULL
) return NULL
;
291 for (len
=i
=0;s
[i
];i
++) {
292 if (NBT_CHAR_ALLOW(s
[i
])) {
295 snprintf(&ret
[len
], 4, "%%%02x", (unsigned char)s
[i
]);
306 form a string for a NBT name
308 _PUBLIC_
char *nbt_name_string(TALLOC_CTX
*mem_ctx
, const struct nbt_name
*name
)
310 TALLOC_CTX
*tmp_ctx
= talloc_new(mem_ctx
);
313 ret
= talloc_asprintf(mem_ctx
, "%s<%02x>-%s",
314 nbt_hex_encode(tmp_ctx
, name
->name
),
316 nbt_hex_encode(tmp_ctx
, name
->scope
));
318 ret
= talloc_asprintf(mem_ctx
, "%s<%02x>",
319 nbt_hex_encode(tmp_ctx
, name
->name
),
322 talloc_free(tmp_ctx
);
327 pull a nbt name, WINS Replication uses another on wire format for nbt name
329 _PUBLIC_
enum ndr_err_code
ndr_pull_wrepl_nbt_name(struct ndr_pull
*ndr
, int ndr_flags
, struct nbt_name
**_r
)
333 uint32_t namebuf_len
;
335 if (!(ndr_flags
& NDR_SCALARS
)) {
336 return NDR_ERR_SUCCESS
;
339 NDR_CHECK(ndr_pull_align(ndr
, 4));
340 NDR_CHECK(ndr_pull_uint32(ndr
, NDR_SCALARS
, &namebuf_len
));
341 if (namebuf_len
< 1 || namebuf_len
> 255) {
342 return ndr_pull_error(ndr
, NDR_ERR_ALLOC
, "value out of range");
344 NDR_PULL_ALLOC_N(ndr
, namebuf
, namebuf_len
);
345 NDR_CHECK(ndr_pull_array_uint8(ndr
, NDR_SCALARS
, namebuf
, namebuf_len
));
347 if ((namebuf_len
% 4) == 0) {
349 * [MS-WINSRA] — v20091104 was wrong
350 * regarding section "2.2.10.1 Name Record"
352 * If the name buffer is already 4 byte aligned
353 * Windows (at least 2003 SP1 and 2008) add 4 extra
354 * bytes. This can happen when the name has a scope.
357 NDR_CHECK(ndr_pull_uint32(ndr
, NDR_SCALARS
, &pad
));
360 NDR_PULL_ALLOC(ndr
, r
);
362 /* oh wow, what a nasty bug in windows ... */
363 if (namebuf
[0] == 0x1b && namebuf_len
>= 16) {
364 namebuf
[0] = namebuf
[15];
368 if (namebuf_len
< 17) {
371 r
->name
= talloc_strndup(r
, (char *)namebuf
, namebuf_len
);
372 if (!r
->name
) return ndr_pull_error(ndr
, NDR_ERR_ALLOC
, "out of memory");
376 talloc_free(namebuf
);
378 return NDR_ERR_SUCCESS
;
381 r
->type
= namebuf
[15];
384 trim_string((char *)namebuf
, NULL
, " ");
385 r
->name
= talloc_strdup(r
, (char *)namebuf
);
386 if (!r
->name
) return ndr_pull_error(ndr
, NDR_ERR_ALLOC
, "out of memory");
388 if (namebuf_len
> 17) {
389 r
->scope
= talloc_strndup(r
, (char *)(namebuf
+16), namebuf_len
-17);
390 if (!r
->scope
) return ndr_pull_error(ndr
, NDR_ERR_ALLOC
, "out of memory");
395 talloc_free(namebuf
);
397 return NDR_ERR_SUCCESS
;
401 push a nbt name, WINS Replication uses another on wire format for nbt name
403 _PUBLIC_
enum ndr_err_code
ndr_push_wrepl_nbt_name(struct ndr_push
*ndr
, int ndr_flags
, const struct nbt_name
*r
)
406 uint32_t namebuf_len
;
408 uint32_t scope_len
= 0;
411 return ndr_push_error(ndr
, NDR_ERR_INVALID_POINTER
,
412 "wrepl_nbt_name NULL pointer");
415 if (!(ndr_flags
& NDR_SCALARS
)) {
416 return NDR_ERR_SUCCESS
;
419 _name_len
= strlen(r
->name
);
420 if (_name_len
> 15) {
421 return ndr_push_error(ndr
, NDR_ERR_STRING
,
422 "wrepl_nbt_name longer as 15 chars: %s",
427 scope_len
= strlen(r
->scope
);
429 if (scope_len
> 238) {
430 return ndr_push_error(ndr
, NDR_ERR_STRING
,
431 "wrepl_nbt_name scope longer as 238 chars: %s",
435 namebuf
= (uint8_t *)talloc_asprintf(ndr
, "%-15s%c%s",
437 (r
->scope
?r
->scope
:""));
438 if (!namebuf
) return ndr_push_error(ndr
, NDR_ERR_ALLOC
, "out of memory");
440 namebuf_len
= strlen((char *)namebuf
) + 1;
443 * we need to set the type here, and use a place-holder in the talloc_asprintf()
444 * as the type can be 0x00, and then the namebuf_len = strlen(namebuf); would give wrong results
446 namebuf
[15] = r
->type
;
448 /* oh wow, what a nasty bug in windows ... */
449 if (r
->type
== 0x1b) {
450 namebuf
[15] = namebuf
[0];
454 NDR_CHECK(ndr_push_align(ndr
, 4));
455 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, namebuf_len
));
456 NDR_CHECK(ndr_push_array_uint8(ndr
, NDR_SCALARS
, namebuf
, namebuf_len
));
458 if ((namebuf_len
% 4) == 0) {
460 * [MS-WINSRA] — v20091104 was wrong
461 * regarding section "2.2.10.1 Name Record"
463 * If the name buffer is already 4 byte aligned
464 * Windows (at least 2003 SP1 and 2008) add 4 extra
465 * bytes. This can happen when the name has a scope.
467 NDR_CHECK(ndr_push_zero(ndr
, 4));
470 talloc_free(namebuf
);
471 return NDR_ERR_SUCCESS
;
474 _PUBLIC_
void ndr_print_wrepl_nbt_name(struct ndr_print
*ndr
, const char *name
, const struct nbt_name
*r
)
476 char *s
= nbt_name_string(ndr
, r
);
477 ndr_print_string(ndr
, name
, s
);
481 _PUBLIC_
enum ndr_err_code
ndr_push_nbt_res_rec(struct ndr_push
*ndr
, int ndr_flags
, const struct nbt_res_rec
*r
)
484 uint32_t _flags_save_STRUCT
= ndr
->flags
;
485 ndr_set_flags(&ndr
->flags
, LIBNDR_PRINT_ARRAY_HEX
);
486 if (ndr_flags
& NDR_SCALARS
) {
487 NDR_CHECK(ndr_push_align(ndr
, 4));
488 NDR_CHECK(ndr_push_nbt_name(ndr
, NDR_SCALARS
, &r
->name
));
489 NDR_CHECK(ndr_push_nbt_qtype(ndr
, NDR_SCALARS
, r
->rr_type
));
490 NDR_CHECK(ndr_push_nbt_qclass(ndr
, NDR_SCALARS
, r
->rr_class
));
491 NDR_CHECK(ndr_push_uint32(ndr
, NDR_SCALARS
, r
->ttl
));
492 NDR_CHECK(ndr_push_set_switch_value(ndr
, &r
->rdata
, ((((r
->rr_type
) == NBT_QTYPE_NETBIOS
) && ((r
->rdata
).data
.length
== 2))?0:r
->rr_type
)));
493 NDR_CHECK(ndr_push_nbt_rdata(ndr
, NDR_SCALARS
, &r
->rdata
));
495 if (ndr_flags
& NDR_BUFFERS
) {
497 ndr
->flags
= _flags_save_STRUCT
;
499 return NDR_ERR_SUCCESS
;