sec/SecurityTool/SecurityTool.h

   1 /*
   2  * Copyright (c) 2003-2004,2006-2007 Apple Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  *
  23  * security.h
  24  */
  25
  26 #ifndef _SECURITYTOOL_H_
  27 #define _SECURITYTOOL_H_
  28
  29 #include <sys/cdefs.h>
  30
  31 __BEGIN_DECLS
  32
  33 typedef int(*command_func)(int argc, char * const *argv);
  34
  35 /* Entry in commands array for a command. */
  36 typedef struct command
  37 {
  38     const char *c_name;    /* name of the command. */
  39     command_func c_func;   /* function to execute the command. */
  40     const char *c_usage;   /* usage sting for command. */
  41     const char *c_help;    /* help string for (or description of) command. */
  42 } command;
  43
  44 /*
  45  * The command array itself.
  46  * Add commands here at will.
  47  * Matching is done on a prefix basis.  The first command in the array
  48  * gets matched first.
  49  */
  50 extern const command commands[];
  51
  52 /* Our one builtin command.
  53  */
  54 int help(int argc, char * const *argv);
  55
  56 /* If 1 attempt to be as quiet as possible. */
  57 extern int do_quiet;
  58
  59 /* If 1 attempt to be as verbose as possible. */
  60 extern int do_verbose;
  61
  62 extern const char* prog_name;
  63
  64 __END_DECLS
  65
  66 #endif /*  _SECURITY_H_ */