docs: Document the -g option of smbclient.
[Samba/gbeck.git] / source3 / include / includes.h
blob3f35602ba6ebd8e32df452979dba9433153428dc
1 #ifndef _INCLUDES_H
2 #define _INCLUDES_H
3 /*
4 Unix SMB/CIFS implementation.
5 Machine customisation and include handling
6 Copyright (C) Andrew Tridgell 1994-1998
7 Copyright (C) 2002 by Martin Pool <mbp@samba.org>
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/>.
23 /* work around broken krb5.h on sles9 */
24 #ifdef SIZEOF_LONG
25 #undef SIZEOF_LONG
26 #endif
28 #include "../replace/replace.h"
30 /* make sure we have included the correct config.h */
31 #ifndef NO_CONFIG_H /* for some tests */
32 #ifndef CONFIG_H_IS_FROM_SAMBA
33 #error "make sure you have removed all config.h files from standalone builds!"
34 #error "the included config.h isn't from samba!"
35 #endif
36 #endif /* NO_CONFIG_H */
38 /* only do the C++ reserved word check when we compile
39 to include --with-developer since too many systems
40 still have comflicts with their header files (e.g. IRIX 6.4) */
42 #if !defined(__cplusplus) && defined(DEVELOPER)
43 #define class #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
44 #define private #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
45 #define public #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
46 #define protected #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
47 #define template #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
48 #define this #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
49 #define new #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
50 #define delete #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
51 #define friend #error DONT_USE_CPLUSPLUS_RESERVED_NAMES
52 #endif
54 #include "local.h"
56 #ifdef AIX
57 #define DEFAULT_PRINTING PRINT_AIX
58 #define PRINTCAP_NAME "/etc/qconfig"
59 #endif
61 #ifdef HPUX
62 #define DEFAULT_PRINTING PRINT_HPUX
63 #endif
65 #ifdef QNX
66 #define DEFAULT_PRINTING PRINT_QNX
67 #endif
69 #ifdef SUNOS4
70 /* on SUNOS4 termios.h conflicts with sys/ioctl.h */
71 #undef HAVE_TERMIOS_H
72 #endif
74 #ifdef RELIANTUNIX
76 * <unistd.h> has to be included before any other to get
77 * large file support on Reliant UNIX. Yes, it's broken :-).
79 #ifdef HAVE_UNISTD_H
80 #include <unistd.h>
81 #endif
82 #endif /* RELIANTUNIX */
84 #include "system/capability.h"
85 #include "system/dir.h"
86 #include "system/filesys.h"
87 #include "system/glob.h"
88 #include "system/iconv.h"
89 #include "system/locale.h"
90 #include "system/network.h"
91 #include "system/passwd.h"
92 #include "system/readline.h"
93 #include "system/select.h"
94 #include "system/shmem.h"
95 #include "system/syslog.h"
96 #include "system/terminal.h"
97 #include "system/time.h"
98 #include "system/wait.h"
100 #if defined(HAVE_RPC_RPC_H)
102 * Check for AUTH_ERROR define conflict with rpc/rpc.h in prot.h.
104 #if defined(HAVE_SYS_SECURITY_H) && defined(HAVE_RPC_AUTH_ERROR_CONFLICT)
105 #undef AUTH_ERROR
106 #endif
108 * HP-UX 11.X has TCP_NODELAY and TCP_MAXSEG defined in <netinet/tcp.h> which
109 * was included above. However <rpc/rpc.h> includes <sys/xti.h> which defines
110 * them again without checking if they already exsist. This generates
111 * two "Redefinition of macro" warnings for every single .c file that is
112 * compiled.
114 #if defined(HPUX) && defined(TCP_NODELAY)
115 #undef TCP_NODELAY
116 #endif
117 #if defined(HPUX) && defined(TCP_MAXSEG)
118 #undef TCP_MAXSEG
119 #endif
120 #include <rpc/rpc.h>
121 #endif
123 #if defined(HAVE_YP_GET_DEFAULT_DOMAIN) && defined(HAVE_SETNETGRENT) && defined(HAVE_ENDNETGRENT) && defined(HAVE_GETNETGRENT)
124 #define HAVE_NETGROUP 1
125 #endif
127 #if defined (HAVE_NETGROUP)
128 #if defined(HAVE_RPCSVC_YP_PROT_H)
130 * HP-UX 11.X has TCP_NODELAY and TCP_MAXSEG defined in <netinet/tcp.h> which
131 * was included above. However <rpc/rpc.h> includes <sys/xti.h> which defines
132 * them again without checking if they already exsist. This generates
133 * two "Redefinition of macro" warnings for every single .c file that is
134 * compiled.
136 #if defined(HPUX) && defined(TCP_NODELAY)
137 #undef TCP_NODELAY
138 #endif
139 #if defined(HPUX) && defined(TCP_MAXSEG)
140 #undef TCP_MAXSEG
141 #endif
142 #include <rpcsvc/yp_prot.h>
143 #endif
144 #if defined(HAVE_RPCSVC_YPCLNT_H)
145 #include <rpcsvc/ypclnt.h>
146 #endif
147 #endif /* HAVE_NETGROUP */
149 #if HAVE_KRB5_H
150 #include <krb5.h>
151 #else
152 #undef HAVE_KRB5
153 #endif
155 #if HAVE_LBER_H
156 #include <lber.h>
157 #if defined(HPUX) && !defined(_LBER_TYPES_H)
158 /* Define ber_tag_t and ber_int_t for using
159 * HP LDAP-UX Integration products' LDAP libraries.
161 #ifndef ber_tag_t
162 typedef unsigned long ber_tag_t;
163 typedef int ber_int_t;
164 #endif
165 #endif /* defined(HPUX) && !defined(_LBER_TYPES_H) */
166 #ifndef LBER_USE_DER
167 #define LBER_USE_DER 0x01
168 #endif
169 #endif
171 #if HAVE_LDAP_H
172 #include <ldap.h>
173 #ifndef LDAP_CONST
174 #define LDAP_CONST const
175 #endif
176 #ifndef LDAP_OPT_SUCCESS
177 #define LDAP_OPT_SUCCESS 0
178 #endif
179 /* Solaris 8 and maybe other LDAP implementations spell this "..._INPROGRESS": */
180 #if defined(LDAP_SASL_BIND_INPROGRESS) && !defined(LDAP_SASL_BIND_IN_PROGRESS)
181 #define LDAP_SASL_BIND_IN_PROGRESS LDAP_SASL_BIND_INPROGRESS
182 #endif
183 /* Solaris 8 defines SSL_LDAP_PORT, not LDAPS_PORT and it only does so if
184 LDAP_SSL is defined - but SSL is not working. We just want the
185 port number! Let's just define LDAPS_PORT correct. */
186 #if !defined(LDAPS_PORT)
187 #define LDAPS_PORT 636
188 #endif
189 #else
190 #undef HAVE_LDAP
191 #endif
193 #if HAVE_GSSAPI_H
194 #include <gssapi.h>
195 #elif HAVE_GSSAPI_GSSAPI_H
196 #include <gssapi/gssapi.h>
197 #elif HAVE_GSSAPI_GSSAPI_GENERIC_H
198 #include <gssapi/gssapi_generic.h>
199 #endif
201 #if HAVE_COM_ERR_H
202 #include <com_err.h>
203 #endif
205 #if HAVE_SYS_ATTRIBUTES_H
206 #include <sys/attributes.h>
207 #endif
209 #ifndef ENOATTR
210 #define ENOATTR ENODATA
211 #endif
213 /* mutually exclusive (SuSE 8.2) */
214 #if HAVE_ATTR_XATTR_H
215 #include <attr/xattr.h>
216 #elif HAVE_SYS_XATTR_H
217 #include <sys/xattr.h>
218 #endif
220 #ifdef HAVE_SYS_EA_H
221 #include <sys/ea.h>
222 #endif
224 #ifdef HAVE_SYS_EXTATTR_H
225 #include <sys/extattr.h>
226 #endif
228 #ifdef HAVE_SYS_UIO_H
229 #include <sys/uio.h>
230 #endif
232 #if HAVE_LANGINFO_H
233 #include <langinfo.h>
234 #endif
236 #if HAVE_NETGROUP_H
237 #include <netgroup.h>
238 #endif
240 #if defined(HAVE_AIO_H) && defined(WITH_AIO)
241 #include <aio.h>
242 #endif
244 /* skip valgrind headers on 64bit AMD boxes */
245 #ifndef HAVE_64BIT_LINUX
246 /* Special macros that are no-ops except when run under Valgrind on
247 * x86. They've moved a little bit from valgrind 1.0.4 to 1.9.4 */
248 #if HAVE_VALGRIND_MEMCHECK_H
249 /* memcheck.h includes valgrind.h */
250 #include <valgrind/memcheck.h>
251 #elif HAVE_VALGRIND_H
252 #include <valgrind.h>
253 #endif
254 #endif
256 /* If we have --enable-developer and the valgrind header is present,
257 * then we're OK to use it. Set a macro so this logic can be done only
258 * once. */
259 #if defined(DEVELOPER) && !defined(HAVE_64BIT_LINUX)
260 #if (HAVE_VALGRIND_H || HAVE_VALGRIND_VALGRIND_H)
261 #define VALGRIND
262 #endif
263 #endif
266 /* we support ADS if we want it and have krb5 and ldap libs */
267 #if defined(WITH_ADS) && defined(HAVE_KRB5) && defined(HAVE_LDAP)
268 #define HAVE_ADS
269 #endif
272 * Define additional missing types
274 #if defined(AIX)
275 typedef sig_atomic_t SIG_ATOMIC_T;
276 #else
277 typedef sig_atomic_t volatile SIG_ATOMIC_T;
278 #endif
280 #ifndef uchar
281 #define uchar unsigned char
282 #endif
285 Samba needs type definitions for int16, int32, uint16 and uint32.
287 Normally these are signed and unsigned 16 and 32 bit integers, but
288 they actually only need to be at least 16 and 32 bits
289 respectively. Thus if your word size is 8 bytes just defining them
290 as signed and unsigned int will work.
293 #ifndef uint8
294 #define uint8 uint8_t
295 #endif
297 #if !defined(int16) && !defined(HAVE_INT16_FROM_RPC_RPC_H)
298 # define int16 int16_t
299 /* needed to work around compile issue on HP-UX 11.x */
300 # define _INT16 1
301 #endif
304 * Note we duplicate the size tests in the unsigned
305 * case as int16 may be a typedef from rpc/rpc.h
309 #if !defined(uint16) && !defined(HAVE_UINT16_FROM_RPC_RPC_H)
310 # define uint16 uint16_t
311 #endif
313 #if !defined(int32) && !defined(HAVE_INT32_FROM_RPC_RPC_H)
314 # define int32 int32_t
315 /* needed to work around compile issue on HP-UX 11.x */
316 # define _INT32 1
317 #endif
320 * Note we duplicate the size tests in the unsigned
321 * case as int32 may be a typedef from rpc/rpc.h
324 #if !defined(uint32) && !defined(HAVE_UINT32_FROM_RPC_RPC_H)
325 # define uint32 uint32_t
326 #endif
329 * check for 8 byte long long
332 #if !defined(uint64)
333 # define uint64 uint64_t
334 #endif
336 #if !defined(int64)
337 # define int64 int64_t
338 #endif
342 * Types for devices, inodes and offsets.
345 #ifndef SMB_DEV_T
346 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_DEV64_T)
347 # define SMB_DEV_T dev64_t
348 # else
349 # define SMB_DEV_T dev_t
350 # endif
351 #endif
353 #ifndef LARGE_SMB_DEV_T
354 # if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_DEV64_T)) || (defined(SIZEOF_DEV_T) && (SIZEOF_DEV_T == 8))
355 # define LARGE_SMB_DEV_T 1
356 # endif
357 #endif
359 #ifdef LARGE_SMB_DEV_T
360 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),(v)&0xFFFFFFFF), SIVAL((p),(ofs)+4,(v)>>32))
361 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(((uint64_t)(IVAL((p),(ofs))))| (((uint64_t)(IVAL((p),(ofs)+4))) << 32)))
362 #else
363 #define SDEV_T_VAL(p, ofs, v) (SIVAL((p),(ofs),v),SIVAL((p),(ofs)+4,0))
364 #define DEV_T_VAL(p, ofs) ((SMB_DEV_T)(IVAL((p),(ofs))))
365 #endif
368 * Setup the correctly sized inode type.
371 #ifndef SMB_INO_T
372 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_INO64_T)
373 # define SMB_INO_T ino64_t
374 # else
375 # define SMB_INO_T ino_t
376 # endif
377 #endif
379 #ifndef LARGE_SMB_INO_T
380 # if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_INO64_T)) || (defined(SIZEOF_INO_T) && (SIZEOF_INO_T == 8))
381 # define LARGE_SMB_INO_T 1
382 # endif
383 #endif
385 #ifdef LARGE_SMB_INO_T
386 #define SINO_T_VAL(p, ofs, v) (SIVAL((p),(ofs),(v)&0xFFFFFFFF), SIVAL((p),(ofs)+4,(v)>>32))
387 #define INO_T_VAL(p, ofs) ((SMB_INO_T)(((uint64_t)(IVAL(p,ofs)))| (((uint64_t)(IVAL(p,(ofs)+4))) << 32)))
388 #else
389 #define SINO_T_VAL(p, ofs, v) (SIVAL(p,ofs,v),SIVAL(p,(ofs)+4,0))
390 #define INO_T_VAL(p, ofs) ((SMB_INO_T)(IVAL((p),(ofs))))
391 #endif
393 #ifndef SMB_OFF_T
394 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_OFF64_T)
395 # define SMB_OFF_T off64_t
396 # else
397 # define SMB_OFF_T off_t
398 # endif
399 #endif
401 #define SBIG_UINT(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
402 #define IVAL2_TO_SMB_BIG_UINT(buf,off) ( (((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF)) | \
403 (( ((uint64_t)(IVAL((buf),(off+4)))) & ((uint64_t)0xFFFFFFFF) ) << 32 ) )
406 /* this should really be a 64 bit type if possible */
407 typedef uint64_t br_off;
409 #define SMB_OFF_T_BITS (sizeof(SMB_OFF_T)*8)
412 * Set the define that tells us if we can do 64 bit
413 * NT SMB calls.
416 #ifndef LARGE_SMB_OFF_T
417 # if (defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_OFF64_T)) || (defined(SIZEOF_OFF_T) && (SIZEOF_OFF_T == 8))
418 # define LARGE_SMB_OFF_T 1
419 # endif
420 #endif
422 #ifdef LARGE_SMB_OFF_T
423 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,(v)&0xFFFFFFFF), SIVAL(p,(ofs)+4,(v)>>32))
424 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,(v)&0xFFFFFFFF), SIVAL(p,ofs,(v)>>32))
425 #define IVAL_TO_SMB_OFF_T(buf,off) ((SMB_OFF_T)(( ((uint64_t)(IVAL((buf),(off)))) & ((uint64_t)0xFFFFFFFF) )))
426 #else
427 #define SOFF_T(p, ofs, v) (SIVAL(p,ofs,v),SIVAL(p,(ofs)+4,0))
428 #define SOFF_T_R(p, ofs, v) (SIVAL(p,(ofs)+4,v),SIVAL(p,ofs,0))
429 #define IVAL_TO_SMB_OFF_T(buf,off) ((SMB_OFF_T)(( ((uint32)(IVAL((buf),(off)))) & 0xFFFFFFFF )))
430 #endif
433 * Type for stat structure.
436 #ifndef SMB_STRUCT_STAT
437 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STAT64) && defined(HAVE_OFF64_T)
438 # define SMB_STRUCT_STAT struct stat64
439 # else
440 # define SMB_STRUCT_STAT struct stat
441 # endif
442 #endif
445 * Type for dirent structure.
448 #ifndef SMB_STRUCT_DIRENT
449 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_DIRENT64)
450 # define SMB_STRUCT_DIRENT struct dirent64
451 # else
452 # define SMB_STRUCT_DIRENT struct dirent
453 # endif
454 #endif
457 * Type for DIR structure.
460 #ifndef SMB_STRUCT_DIR
461 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_DIR64)
462 # define SMB_STRUCT_DIR DIR64
463 # else
464 # define SMB_STRUCT_DIR DIR
465 # endif
466 #endif
469 * Defines for 64 bit fcntl locks.
472 #ifndef SMB_STRUCT_FLOCK
473 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
474 # define SMB_STRUCT_FLOCK struct flock64
475 # else
476 # define SMB_STRUCT_FLOCK struct flock
477 # endif
478 #endif
480 #ifndef SMB_F_SETLKW
481 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
482 # define SMB_F_SETLKW F_SETLKW64
483 # else
484 # define SMB_F_SETLKW F_SETLKW
485 # endif
486 #endif
488 #ifndef SMB_F_SETLK
489 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
490 # define SMB_F_SETLK F_SETLK64
491 # else
492 # define SMB_F_SETLK F_SETLK
493 # endif
494 #endif
496 #ifndef SMB_F_GETLK
497 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_STRUCT_FLOCK64) && defined(HAVE_OFF64_T)
498 # define SMB_F_GETLK F_GETLK64
499 # else
500 # define SMB_F_GETLK F_GETLK
501 # endif
502 #endif
505 * Type for aiocb structure.
508 #ifndef SMB_STRUCT_AIOCB
509 # if defined(WITH_AIO)
510 # if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_AIOCB64)
511 # define SMB_STRUCT_AIOCB struct aiocb64
512 # else
513 # define SMB_STRUCT_AIOCB struct aiocb
514 # endif
515 # else
516 # define SMB_STRUCT_AIOCB int /* AIO not being used but we still need the define.... */
517 # endif
518 #endif
520 #ifndef HAVE_STRUCT_TIMESPEC
521 struct timespec {
522 time_t tv_sec; /* Seconds. */
523 long tv_nsec; /* Nanoseconds. */
525 #endif
527 #ifdef HAVE_BROKEN_GETGROUPS
528 #define GID_T int
529 #else
530 #define GID_T gid_t
531 #endif
533 #ifndef NGROUPS_MAX
534 #define NGROUPS_MAX 32 /* Guess... */
535 #endif
537 /* Our own fstrings */
540 --------------
542 / REST \
543 / IN \
544 / PEACE \
546 | The infamous pstring |
549 | 7 December |
551 | 2007 |
552 *| * * * | *
553 _________)/\\_//(\/(/\)/\//\/\///|_)_______
556 #ifndef FSTRING_LEN
557 #define FSTRING_LEN 256
558 typedef char fstring[FSTRING_LEN];
559 #endif
561 /* Samba 3 doesn't use iconv_convenience: */
562 extern void *global_iconv_convenience;
563 extern void *cmdline_lp_ctx;
564 struct smb_iconv_convenience *lp_iconv_convenience(void *lp_ctx);
566 /* Lists, trees, caching, database... */
567 #include "../lib/util/util.h"
568 #include "../lib/util/xfile.h"
569 #include "../lib/util/memory.h"
570 #include "../lib/util/attr.h"
571 #include "intl.h"
572 #include "../lib/util/dlinklist.h"
573 #include "tdb.h"
574 #include "util_tdb.h"
576 #include "../talloc/talloc.h"
578 #include "../lib/util/data_blob.h"
579 #include "../lib/util/time.h"
580 #include "../lib/util/asn1.h"
582 /* And a little extension. Abort on type mismatch */
583 #define talloc_get_type_abort(ptr, type) \
584 (type *)talloc_check_name_abort(ptr, #type)
586 #include "ads.h"
587 #include "ads_dns.h"
588 #include "interfaces.h"
589 #include "trans2.h"
590 #include "../libcli/util/error.h"
591 #include "ntioctl.h"
592 #include "charset.h"
593 #include "dynconfig.h"
594 #include "util_getent.h"
595 #include "debugparse.h"
596 #include "version.h"
597 #include "privileges.h"
598 #include "messages.h"
599 #include "locking.h"
600 #include "smb.h"
601 #include "nameserv.h"
602 #include "secrets.h"
603 #include "../lib/util/byteorder.h"
604 #include "privileges.h"
605 #include "rpc_misc.h"
606 #include "rpc_dce.h"
607 #include "mapping.h"
608 #include "passdb.h"
609 #include "rpc_secdes.h"
610 #include "gpo.h"
611 #include "authdata.h"
612 #include "msdfs.h"
613 #include "rap.h"
614 #include "../lib/crypto/md5.h"
615 #include "../lib/crypto/md4.h"
616 #include "../lib/crypto/arcfour.h"
617 #include "../lib/crypto/crc32.h"
618 #include "../lib/crypto/hmacmd5.h"
619 #include "ntlmssp.h"
620 #include "auth.h"
621 #include "ntdomain.h"
622 #include "rpc_svcctl.h"
623 #include "rpc_lsa.h"
624 #include "reg_objects.h"
625 #include "reg_db.h"
626 #include "rpc_spoolss.h"
627 #include "rpc_eventlog.h"
628 #include "rpc_perfcount.h"
629 #include "rpc_perfcount_defs.h"
630 #include "librpc/gen_ndr/notify.h"
631 #include "librpc/gen_ndr/xattr.h"
632 #include "librpc/gen_ndr/messaging.h"
633 #include "librpc/gen_ndr/ndr_nbt.h"
634 #include "librpc/rpc/dcerpc.h"
635 #include "nt_printing.h"
636 #include "idmap.h"
637 #include "client.h"
639 #include "session.h"
640 #include "popt.h"
641 #include "mangle.h"
642 #include "module.h"
643 #include "nsswitch/winbind_client.h"
644 #include "spnego.h"
645 #include "rpc_client.h"
646 #include "event.h"
647 #include "dbwrap.h"
648 #include "packet.h"
649 #include "ctdbd_conn.h"
650 #include "../lib/util/talloc_stack.h"
651 #include "memcache.h"
652 #include "async_req.h"
653 #include "async_smb.h"
654 #include "async_sock.h"
655 #include "services.h"
656 #include "eventlog.h"
658 #include "lib/smbconf/smbconf.h"
660 /* Defines for wisXXX functions. */
661 #define UNI_UPPER 0x1
662 #define UNI_LOWER 0x2
663 #define UNI_DIGIT 0x4
664 #define UNI_XDIGIT 0x8
665 #define UNI_SPACE 0x10
667 #include "nsswitch/winbind_nss.h"
669 /* forward declaration from printing.h to get around
670 header file dependencies */
672 struct printjob;
674 /* forward declarations from smbldap.c */
676 #include "smbldap.h"
678 #include "smb_ldap.h"
680 struct dns_reg_state;
682 void dns_register_smbd(struct dns_reg_state ** dns_state_ptr,
683 unsigned port,
684 int *maxfd,
685 fd_set *listen_set,
686 struct timeval *timeout);
688 void dns_register_close(struct dns_reg_state ** dns_state_ptr);
691 bool dns_register_smbd_reply(struct dns_reg_state *dns_state,
692 fd_set *lfds, struct timeval *timeout);
695 * Reasons for cache flush.
698 enum flush_reason_enum {
699 SEEK_FLUSH,
700 READ_FLUSH,
701 WRITE_FLUSH,
702 READRAW_FLUSH,
703 OPLOCK_RELEASE_FLUSH,
704 CLOSE_FLUSH,
705 SYNC_FLUSH,
706 SIZECHANGE_FLUSH,
707 /* NUM_FLUSH_REASONS must remain the last value in the enumeration. */
708 NUM_FLUSH_REASONS};
710 #include "nss_info.h"
711 #include "modules/nfs4_acls.h"
712 #include "nsswitch/libwbclient/wbclient.h"
714 /***** prototypes *****/
715 #ifndef NO_PROTO_H
716 #include "proto.h"
717 #endif
719 #if defined(HAVE_POSIX_ACLS)
720 #include "modules/vfs_posixacl.h"
721 #endif
723 #if defined(HAVE_TRU64_ACLS)
724 #include "modules/vfs_tru64acl.h"
725 #endif
727 #if defined(HAVE_SOLARIS_ACLS) || defined(HAVE_UNIXWARE_ACLS)
728 #include "modules/vfs_solarisacl.h"
729 #endif
731 #if defined(HAVE_HPUX_ACLS)
732 #include "modules/vfs_hpuxacl.h"
733 #endif
735 #if defined(HAVE_IRIX_ACLS)
736 #include "modules/vfs_irixacl.h"
737 #endif
739 #ifdef HAVE_LDAP
740 #include "ads_protos.h"
741 #endif
743 /* We need this after proto.h to reference GetTimeOfDay(). */
744 #include "smbprofile.h"
746 /* String routines */
748 #include "srvstr.h"
749 #include "safe_string.h"
751 /* prototypes from lib/util_transfer_file.c */
752 #include "transfer_file.h"
754 #ifndef DEFAULT_PRINTING
755 #ifdef HAVE_CUPS
756 #define DEFAULT_PRINTING PRINT_CUPS
757 #define PRINTCAP_NAME "cups"
758 #elif defined(SYSV)
759 #define DEFAULT_PRINTING PRINT_SYSV
760 #define PRINTCAP_NAME "lpstat"
761 #else
762 #define DEFAULT_PRINTING PRINT_BSD
763 #define PRINTCAP_NAME "/etc/printcap"
764 #endif
765 #endif
767 #ifndef PRINTCAP_NAME
768 #define PRINTCAP_NAME "/etc/printcap"
769 #endif
771 #ifndef SIGCLD
772 #define SIGCLD SIGCHLD
773 #endif
775 #ifndef SIGRTMIN
776 #define SIGRTMIN 32
777 #endif
779 #ifndef MAP_FILE
780 #define MAP_FILE 0
781 #endif
783 #if defined(HAVE_PUTPRPWNAM) && defined(AUTH_CLEARTEXT_SEG_CHARS)
784 #define OSF1_ENH_SEC 1
785 #endif
787 #ifndef ALLOW_CHANGE_PASSWORD
788 #if (defined(HAVE_TERMIOS_H) && defined(HAVE_DUP2) && defined(HAVE_SETSID))
789 #define ALLOW_CHANGE_PASSWORD 1
790 #endif
791 #endif
793 /* what is the longest significant password available on your system?
794 Knowing this speeds up password searches a lot */
795 #ifndef PASSWORD_LENGTH
796 #define PASSWORD_LENGTH 8
797 #endif
799 #ifndef HAVE_PIPE
800 #define SYNC_DNS 1
801 #endif
803 #if defined(HAVE_CRYPT16) && defined(HAVE_GETAUTHUID)
804 #define ULTRIX_AUTH 1
805 #endif
807 /* yuck, I'd like a better way of doing this */
808 #define DIRP_SIZE (256 + 32)
810 /* default socket options. Dave Miller thinks we should default to TCP_NODELAY
811 given the socket IO pattern that Samba uses */
812 #ifdef TCP_NODELAY
813 #define DEFAULT_SOCKET_OPTIONS "TCP_NODELAY"
814 #else
815 #define DEFAULT_SOCKET_OPTIONS ""
816 #endif
818 /* dmalloc -- free heap debugger (dmalloc.org). This should be near
819 * the *bottom* of include files so as not to conflict. */
820 #ifdef ENABLE_DMALLOC
821 # include <dmalloc.h>
822 #endif
825 #if HAVE_KERNEL_SHARE_MODES
826 #ifndef LOCK_MAND
827 #define LOCK_MAND 32 /* This is a mandatory flock */
828 #define LOCK_READ 64 /* ... Which allows concurrent read operations */
829 #define LOCK_WRITE 128 /* ... Which allows concurrent write operations */
830 #define LOCK_RW 192 /* ... Which allows concurrent read & write ops */
831 #endif
832 #endif
834 extern int DEBUGLEVEL;
836 #define MAX_SEC_CTX_DEPTH 8 /* Maximum number of security contexts */
839 #ifdef GLIBC_HACK_FCNTL64
840 /* this is a gross hack. 64 bit locking is completely screwed up on
841 i386 Linux in glibc 2.1.95 (which ships with RedHat 7.0). This hack
842 "fixes" the problem with the current 2.4.0test kernels
844 #define fcntl fcntl64
845 #undef F_SETLKW
846 #undef F_SETLK
847 #define F_SETLK 13
848 #define F_SETLKW 14
849 #endif
852 /* needed for some systems without iconv. Doesn't really matter
853 what error code we use */
854 #ifndef EILSEQ
855 #define EILSEQ EIO
856 #endif
858 /* add varargs prototypes with printf checking */
859 /*PRINTFLIKE2 */
860 int fdprintf(int , const char *, ...) PRINTF_ATTRIBUTE(2,3);
861 /*PRINTFLIKE1 */
862 int d_printf(const char *, ...) PRINTF_ATTRIBUTE(1,2);
863 /*PRINTFLIKE2 */
864 int d_fprintf(FILE *f, const char *, ...) PRINTF_ATTRIBUTE(2,3);
866 /* PRINTFLIKE2 */
867 void sys_adminlog(int priority, const char *format_str, ...) PRINTF_ATTRIBUTE(2,3);
869 /* PRINTFLIKE2 */
870 int fstr_sprintf(fstring s, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
872 int d_vfprintf(FILE *f, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
874 int smb_xvasprintf(char **ptr, const char *format, va_list ap) PRINTF_ATTRIBUTE(2,0);
876 int asprintf_strupper_m(char **strp, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
877 char *talloc_asprintf_strupper_m(TALLOC_CTX *t, const char *fmt, ...) PRINTF_ATTRIBUTE(2,3);
880 * Veritas File System. Often in addition to native.
881 * Quotas different.
883 #if defined(HAVE_SYS_FS_VX_QUOTA_H)
884 #define VXFS_QUOTA
885 #endif
887 #ifndef XATTR_CREATE
888 #define XATTR_CREATE 0x1 /* set value, fail if attr already exists */
889 #endif
891 #ifndef XATTR_REPLACE
892 #define XATTR_REPLACE 0x2 /* set value, fail if attr does not exist */
893 #endif
895 #if defined(HAVE_KRB5)
897 krb5_error_code smb_krb5_parse_name(krb5_context context,
898 const char *name, /* in unix charset */
899 krb5_principal *principal);
901 krb5_error_code smb_krb5_unparse_name(krb5_context context,
902 krb5_const_principal principal,
903 char **unix_name);
905 #ifndef HAVE_KRB5_SET_REAL_TIME
906 krb5_error_code krb5_set_real_time(krb5_context context, int32_t seconds, int32_t microseconds);
907 #endif
909 krb5_error_code krb5_set_default_tgs_ktypes(krb5_context ctx, const krb5_enctype *enc);
911 #if defined(HAVE_KRB5_AUTH_CON_SETKEY) && !defined(HAVE_KRB5_AUTH_CON_SETUSERUSERKEY)
912 krb5_error_code krb5_auth_con_setuseruserkey(krb5_context context, krb5_auth_context auth_context, krb5_keyblock *keyblock);
913 #endif
915 #ifndef HAVE_KRB5_FREE_UNPARSED_NAME
916 void krb5_free_unparsed_name(krb5_context ctx, char *val);
917 #endif
919 /* Stub out initialize_krb5_error_table since it is not present in all
920 * Kerberos implementations. If it's not present, it's not necessary to
921 * call it.
923 #ifndef HAVE_INITIALIZE_KRB5_ERROR_TABLE
924 #define initialize_krb5_error_table()
925 #endif
927 /* Samba wrapper function for krb5 functionality. */
928 bool setup_kaddr( krb5_address *pkaddr, struct sockaddr_storage *paddr);
929 int create_kerberos_key_from_string(krb5_context context, krb5_principal host_princ, krb5_data *password, krb5_keyblock *key, krb5_enctype enctype, bool no_salt);
930 bool get_auth_data_from_tkt(TALLOC_CTX *mem_ctx, DATA_BLOB *auth_data, krb5_ticket *tkt);
931 krb5_const_principal get_principal_from_tkt(krb5_ticket *tkt);
932 krb5_error_code smb_krb5_locate_kdc(krb5_context ctx, const krb5_data *realm, struct sockaddr **addr_pp, int *naddrs, int get_masters);
933 #if defined(HAVE_KRB5_LOCATE_KDC)
934 krb5_error_code krb5_locate_kdc(krb5_context ctx, const krb5_data *realm, struct sockaddr **addr_pp, int *naddrs, int get_masters);
935 #endif
936 krb5_error_code get_kerberos_allowed_etypes(krb5_context context, krb5_enctype **enctypes);
937 bool get_krb5_smb_session_key(krb5_context context, krb5_auth_context auth_context, DATA_BLOB *session_key, bool remote);
938 krb5_error_code smb_krb5_kt_free_entry(krb5_context context, krb5_keytab_entry *kt_entry);
939 krb5_principal kerberos_fetch_salt_princ_for_host_princ(krb5_context context, krb5_principal host_princ, int enctype);
940 void kerberos_set_creds_enctype(krb5_creds *pcreds, int enctype);
941 bool kerberos_compatible_enctypes(krb5_context context, krb5_enctype enctype1, krb5_enctype enctype2);
942 void kerberos_free_data_contents(krb5_context context, krb5_data *pdata);
943 NTSTATUS decode_pac_data(TALLOC_CTX *mem_ctx,
944 DATA_BLOB *pac_data_blob,
945 krb5_context context,
946 krb5_keyblock *service_keyblock,
947 krb5_const_principal client_principal,
948 time_t tgs_authtime,
949 struct PAC_DATA **pac_data_out);
950 void smb_krb5_checksum_from_pac_sig(krb5_checksum *cksum,
951 struct PAC_SIGNATURE_DATA *sig);
952 krb5_error_code smb_krb5_verify_checksum(krb5_context context,
953 const krb5_keyblock *keyblock,
954 krb5_keyusage usage,
955 krb5_checksum *cksum,
956 uint8 *data,
957 size_t length);
958 time_t get_authtime_from_tkt(krb5_ticket *tkt);
959 void smb_krb5_free_ap_req(krb5_context context,
960 krb5_ap_req *ap_req);
961 krb5_error_code smb_krb5_get_keyinfo_from_ap_req(krb5_context context,
962 const krb5_data *inbuf,
963 krb5_kvno *kvno,
964 krb5_enctype *enctype);
965 krb5_error_code krb5_rd_req_return_keyblock_from_keytab(krb5_context context,
966 krb5_auth_context *auth_context,
967 const krb5_data *inbuf,
968 krb5_const_principal server,
969 krb5_keytab keytab,
970 krb5_flags *ap_req_options,
971 krb5_ticket **ticket,
972 krb5_keyblock **keyblock);
973 krb5_error_code smb_krb5_parse_name_norealm(krb5_context context,
974 const char *name,
975 krb5_principal *principal);
976 bool smb_krb5_principal_compare_any_realm(krb5_context context,
977 krb5_const_principal princ1,
978 krb5_const_principal princ2);
979 int cli_krb5_get_ticket(const char *principal, time_t time_offset,
980 DATA_BLOB *ticket, DATA_BLOB *session_key_krb5, uint32 extra_ap_opts, const char *ccname, time_t *tgs_expire);
981 krb5_error_code smb_krb5_renew_ticket(const char *ccache_string, const char *client_string, const char *service_string, time_t *expire_time);
982 krb5_error_code kpasswd_err_to_krb5_err(krb5_error_code res_code);
983 krb5_error_code smb_krb5_gen_netbios_krb5_address(smb_krb5_addresses **kerb_addr);
984 krb5_error_code smb_krb5_free_addresses(krb5_context context, smb_krb5_addresses *addr);
985 NTSTATUS krb5_to_nt_status(krb5_error_code kerberos_error);
986 krb5_error_code nt_status_to_krb5(NTSTATUS nt_status);
987 void smb_krb5_free_error(krb5_context context, krb5_error *krberror);
988 krb5_error_code handle_krberror_packet(krb5_context context,
989 krb5_data *packet);
991 void smb_krb5_get_init_creds_opt_free(krb5_context context,
992 krb5_get_init_creds_opt *opt);
993 krb5_error_code smb_krb5_get_init_creds_opt_alloc(krb5_context context,
994 krb5_get_init_creds_opt **opt);
995 krb5_error_code smb_krb5_mk_error(krb5_context context,
996 krb5_error_code error_code,
997 const krb5_principal server,
998 krb5_data *reply);
999 krb5_enctype smb_get_enctype_from_kt_entry(krb5_keytab_entry *kt_entry);
1000 krb5_error_code smb_krb5_enctype_to_string(krb5_context context,
1001 krb5_enctype enctype,
1002 char **etype_s);
1003 krb5_error_code smb_krb5_open_keytab(krb5_context context,
1004 const char *keytab_name,
1005 bool write_access,
1006 krb5_keytab *keytab);
1007 krb5_error_code smb_krb5_keytab_name(TALLOC_CTX *mem_ctx,
1008 krb5_context context,
1009 krb5_keytab keytab,
1010 const char **keytab_name);
1011 int smb_krb5_kt_add_entry_ext(krb5_context context,
1012 krb5_keytab keytab,
1013 krb5_kvno kvno,
1014 const char *princ_s,
1015 krb5_enctype *enctypes,
1016 krb5_data password,
1017 bool no_salt,
1018 bool keep_old_entries);
1020 #endif /* HAVE_KRB5 */
1023 #ifdef HAVE_LDAP
1025 /* function declarations not included in proto.h */
1026 LDAP *ldap_open_with_timeout(const char *server, int port, unsigned int to);
1028 #endif /* HAVE_LDAP */
1030 #if defined(HAVE_LINUX_READAHEAD) && ! defined(HAVE_READAHEAD_DECL)
1031 ssize_t readahead(int fd, off64_t offset, size_t count);
1032 #endif
1034 #ifdef TRUE
1035 #undef TRUE
1036 #endif
1037 #define TRUE __ERROR__XX__DONT_USE_TRUE
1039 #ifdef FALSE
1040 #undef FALSE
1041 #endif
1042 #define FALSE __ERROR__XX__DONT_USE_FALSE
1044 /* If we have blacklisted mmap() try to avoid using it accidentally by
1045 undefining the HAVE_MMAP symbol. */
1047 #ifdef MMAP_BLACKLIST
1048 #undef HAVE_MMAP
1049 #endif
1051 void smb_panic( const char *why ) _NORETURN_;
1052 void dump_core(void) _NORETURN_;
1053 void exit_server(const char *const reason) _NORETURN_;
1054 void exit_server_cleanly(const char *const reason) _NORETURN_;
1055 void exit_server_fault(void) _NORETURN_;
1057 #ifdef HAVE_LIBNSCD
1058 #include "libnscd.h"
1059 #endif
1061 #if defined(HAVE_IPV6)
1062 void in6_addr_to_sockaddr_storage(struct sockaddr_storage *ss,
1063 struct in6_addr ip);
1064 #endif
1066 #endif /* _INCLUDES_H */