git.sur5r.net Git - openldap/blob - clients/tools/common.h

   1 /* common.h - common definitions for the ldap client tools */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 1998-2018 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16 /* ACKNOWLEDGEMENTS:
  17  * This file was initially created by Hallvard B. Furuseth based (in
  18  * part) upon argument parsing code for individual tools located in
  19  * this directory.
  20  */
  21
  22 #ifndef _CLIENT_TOOLS_COMMON_H_
  23 #define _CLIENT_TOOLS_COMMON_H_
  24
  25 LDAP_BEGIN_DECL
  26
  27 typedef enum tool_type_t {
  28         TOOL_SEARCH     = 0x01U,
  29         TOOL_COMPARE    = 0x02U,
  30         TOOL_ADD        = 0x04U,
  31         TOOL_DELETE     = 0x08U,
  32         TOOL_MODIFY     = 0x10U,
  33         TOOL_MODRDN     = 0x20U,
  34
  35         TOOL_EXOP       = 0x40U,
  36
  37         TOOL_WHOAMI     = TOOL_EXOP | 0x100U,
  38         TOOL_PASSWD     = TOOL_EXOP | 0x200U,
  39         TOOL_VC         = TOOL_EXOP | 0x400U,
  40
  41         TOOL_WRITE      = (TOOL_ADD|TOOL_DELETE|TOOL_MODIFY|TOOL_MODRDN),
  42         TOOL_READ       = (TOOL_SEARCH|TOOL_COMPARE),
  43
  44         TOOL_ALL        = 0xFFU
  45 } tool_type_t;
  46
  47
  48 /* input-related vars */
  49
  50 /* misc. parameters */
  51 extern tool_type_t      tool_type;
  52 extern int              contoper;
  53 extern int              debug;
  54 extern char             *infile;
  55 extern int              dont;
  56 extern int              referrals;
  57 extern int              verbose;
  58 extern int              ldif;
  59 extern ber_len_t        ldif_wrap;
  60 extern char             *prog;
  61
  62 /* connection */
  63 extern char             *ldapuri;
  64 extern char             *ldaphost;
  65 extern int              ldapport;
  66 extern int              use_tls;
  67 extern int              protocol;
  68 extern int              version;
  69
  70 /* authc/authz */
  71 extern int              authmethod;
  72 extern char             *binddn;
  73 extern int              want_bindpw;
  74 extern struct berval    passwd;
  75 extern char             *pw_file;
  76 #ifdef HAVE_CYRUS_SASL
  77 extern unsigned         sasl_flags;
  78 extern char             *sasl_realm;
  79 extern char             *sasl_authc_id;
  80 extern char             *sasl_authz_id;
  81 extern char             *sasl_mech;
  82 extern char             *sasl_secprops;
  83 #endif
  84
  85 /* controls */
  86 extern char             *assertion;
  87 extern char             *authzid;
  88 extern int              manageDIT;
  89 extern int              manageDSAit;
  90 extern int              noop;
  91 extern int              ppolicy;
  92 extern int              preread, postread;
  93 extern ber_int_t        pr_morePagedResults;
  94 extern struct berval    pr_cookie;
  95 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
  96 extern int              chaining;
  97 #endif /* LDAP_CONTROL_X_CHAINING_BEHAVIOR */
  98 extern ber_int_t        vlvPos;
  99 extern ber_int_t        vlvCount;
 100 extern struct berval    *vlvContext;
 101
 102 /* options */
 103 extern struct timeval   nettimeout;
 104
 105 /* Defined in common.c, set in main() */
 106 extern const char       __Version[];
 107
 108 /* Defined in main program */
 109 extern const char       options[];
 110
 111 void usage LDAP_P(( void )) LDAP_GCCATTR((noreturn));
 112 int handle_private_option LDAP_P(( int i ));
 113
 114 /* Defined in common.c */
 115 void tool_init LDAP_P(( tool_type_t type ));
 116 void tool_common_usage LDAP_P(( void ));
 117 void tool_args LDAP_P(( int, char ** ));
 118 LDAP *tool_conn_setup LDAP_P(( int dont, void (*private_setup)( LDAP * ) ));
 119 void tool_bind LDAP_P(( LDAP * ));
 120 void tool_unbind LDAP_P(( LDAP * ));
 121 void tool_destroy LDAP_P(( void ));
 122 void tool_exit LDAP_P(( LDAP *ld, int status )) LDAP_GCCATTR((noreturn));
 123 void tool_server_controls LDAP_P(( LDAP *, LDAPControl *, int ));
 124 int tool_check_abandon LDAP_P(( LDAP *ld, int msgid ));
 125 void tool_perror LDAP_P((
 126         const char *func,
 127         int err,
 128         const char *extra,
 129         const char *matched,
 130         const char *info,
 131         char **refs ));
 132 void tool_print_ctrls LDAP_P(( LDAP *ld, LDAPControl **ctrls ));
 133 int tool_write_ldif LDAP_P(( int type, char *name, char *value, ber_len_t vallen ));
 134 int tool_is_oid LDAP_P(( const char *s ));
 135
 136
 137 LDAP_END_DECL
 138
 139 #endif /* _CLIENT_TOOLS_COMMON_H_ */