Implemented more gpg-agen options to support certain passphrase policies.
[gnupg.git] / common / exechelp.h
1 /* exechelp.h - Definitions for the fork and exec helpers
2  *      Copyright (C) 2004 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 <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef GNUPG_COMMON_EXECHELP_H
21 #define GNUPG_COMMON_EXECHELP_H
22
23
24
25 /* Fork and exec the PGMNAME, connect the file descriptor of INFILE to
26    stdin, write the output to OUTFILE, return a new stream in
27    STATUSFILE for stderr and the pid of the process in PID. The
28    arguments for the process are expected in the NULL terminated array
29    ARGV.  The program name itself should not be included there.  if
30    PREEXEC is not NULL, that function will be called right before the
31    exec.  Calling gnupg_wait_process is required.  Returns 0 on
32    success or an error code. */
33 gpg_error_t gnupg_spawn_process (const char *pgmname, const char *argv[],
34                                  FILE *infile, FILE *outfile,
35                                  void (*preexec)(void),
36                                  FILE **statusfile, pid_t *pid);
37
38
39 /* Simplified version of gnupg_spawn_process.  This function forks and
40    then execs PGMNAME, while connecting INFD to stdin, OUTFD to stdout
41    and ERRFD to stderr (any of them may be -1 to connect them to
42    /dev/null).  The arguments for the process are expected in the NULL
43    terminated array ARGV.  The program name itself should not be
44    included there.  Calling gnupg_wait_process is required.  Returns 0
45    on success or an error code. */
46 gpg_error_t gnupg_spawn_process_fd (const char *pgmname, 
47                                     const char *argv[],
48                                     int infd, int outfd, int errfd,
49                                     pid_t *pid);
50
51
52 /* Wait for the process identified by PID to terminate. PGMNAME should
53    be the same as supplied to the spawn fucntion and is only used for
54    diagnostics.  Returns 0 if the process succeded, GPG_ERR_GENERAL
55    for any failures of the spawned program or other error codes.*/
56 gpg_error_t gnupg_wait_process (const char *pgmname, pid_t pid);
57
58
59 /* Spawn a new process and immediatley detach from it.  The name of
60    the program to exec is PGMNAME and its arguments are in ARGV (the
61    programname is automatically passed as first argument).
62    Environment strings in ENVP are set.  An error is returned if
63    pgmname is not executable; to make this work it is necessary to
64    provide an absolute file name.  */
65 gpg_error_t gnupg_spawn_process_detached (const char *pgmname,
66                                           const char *argv[],
67                                           const char *envp[] );
68
69
70
71 #endif /*GNUPG_COMMON_EXECHELP_H*/