agent: Stop scdaemon after reload when disable_scdaemon.
[gnupg.git] / tools / gpgconf.h
1 /* gpgconf.h - Global definitions for gpgconf
2  *      Copyright (C) 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <https://www.gnu.org/licenses/>.
18  */
19
20 #ifndef GPGCONF_H
21 #define GPGCONF_H
22
23 #include "../common/util.h"
24
25 /* We keep all global options in the structure OPT.  */
26 struct
27 {
28   int verbose;          /* Verbosity level.  */
29   int quiet;            /* Be extra quiet.  */
30   int dry_run;          /* Don't change any persistent data.  */
31   int runtime;          /* Make changes active at runtime.  */
32   int null;             /* Option -0 active.  */
33   char *outfile;        /* Name of output file.  */
34
35   int component;        /* The active component.  */
36 } opt;
37
38
39 /*-- gpgconf.c --*/
40 void gpgconf_write_status (int no, const char *format,
41                            ...) GPGRT_ATTR_PRINTF(2,3);
42 void gpgconf_failure (gpg_error_t err) GPGRT_ATTR_NORETURN;
43
44 /*-- gpgconf-comp.c --*/
45
46 /* Component system.  Each component is a set of options that can be
47  * configured at the same time.  If you change this, don't forget to
48  * update GC_COMPONENT in gpgconf-comp.c.  */
49 typedef enum
50   {
51     /* The classic GPG for OpenPGP.  */
52     GC_COMPONENT_GPG,
53
54     /* The GPG Agent.  */
55     GC_COMPONENT_GPG_AGENT,
56
57     /* The Smardcard Daemon.  */
58     GC_COMPONENT_SCDAEMON,
59
60     /* GPG for S/MIME.  */
61     GC_COMPONENT_GPGSM,
62
63     /* The LDAP Directory Manager for CRLs.  */
64     GC_COMPONENT_DIRMNGR,
65
66     /* The external Pinentry.  */
67     GC_COMPONENT_PINENTRY,
68
69     /* The number of components.  */
70     GC_COMPONENT_NR
71   } gc_component_t;
72
73
74 /* Initialize the components.  */
75 void gc_components_init (void);
76
77 /* Percent-Escape special characters.  The string is valid until the
78    next invocation of the function.  */
79 char *gc_percent_escape (const char *src);
80
81
82 void gc_error (int status, int errnum, const char *fmt, ...);
83
84 /* Launch given component.  */
85 gpg_error_t gc_component_launch (int component);
86
87 /* Kill given component.  */
88 void gc_component_kill (int component);
89
90 /* Reload given component.  */
91 void gc_component_reload (int component);
92
93 /* List all components that are available.  */
94 void gc_component_list_components (estream_t out);
95
96 /* List all programs along with their status.  */
97 void gc_check_programs (estream_t out);
98
99 /* Find the component with the name NAME.  Returns -1 if not
100    found.  */
101 int gc_component_find (const char *name);
102
103 /* Retrieve the currently active options and their defaults from all
104    involved backends for this component.  */
105 void gc_component_retrieve_options (int component);
106
107 /* List all options of the component COMPONENT.  */
108 void gc_component_list_options (int component, estream_t out);
109
110 /* Read the modifications from IN and apply them.  */
111 void gc_component_change_options (int component, estream_t in, estream_t out,
112                                   int verbatim);
113
114 /* Check the options of a single component.  Returns 0 if everything
115    is OK.  */
116 int gc_component_check_options (int component, estream_t out,
117                                 const char *conf_file);
118
119 /* Process global configuration file.  */
120 int gc_process_gpgconf_conf (const char *fname, int update, int defaults,
121                              estream_t listfp);
122
123 /* Apply a profile.  */
124 gpg_error_t gc_apply_profile (const char *fname);
125
126
127 #endif /*GPGCONF_H*/