diff options
| -rw-r--r-- | src/assuan-socket-connect.c | 41 | ||||
| -rw-r--r-- | src/assuan.h.in | 103 |
2 files changed, 81 insertions, 63 deletions
diff --git a/src/assuan-socket-connect.c b/src/assuan-socket-connect.c index c54c44d..ed18095 100644 --- a/src/assuan-socket-connect.c +++ b/src/assuan-socket-connect.c @@ -78,7 +78,7 @@ /* Returns true if STR represents a valid port number in decimal - notation and no garbage is following. */ + * notation and no garbage is following. */ static int parse_portno (const char *str, uint16_t *r_port) { @@ -168,26 +168,25 @@ assuan_socket_connect_fd (assuan_context_t ctx, int fd, unsigned int flags) /* Make a connection to the Unix domain socket NAME and return a new - Assuan context in CTX. SERVER_PID is currently not used but may - become handy in the future. Defined flag bits are: - - ASSUAN_SOCKET_CONNECT_FDPASSING - sendmsg and recvmsg are used. - - NAME must either start with a slash and optional with a drive - prefix ("c:") or use one of these URL schemata: - - file://<fname> - - This is the same as the default just with an explicit schemata. - - assuan://<ipaddr>:<port> - assuan://[<ip6addr>]:<port> - - Connect using TCP to PORT of the server with the numerical - IPADDR. Note that '[' and ']' are literal characters. - - */ + * Assuan context in CTX. SERVER_PID is currently not used but may + * become handy in the future. Defined flag bits are: + * + * ASSUAN_SOCKET_CONNECT_FDPASSING + * sendmsg and recvmsg are used. + * + * NAME must either start with a slash and optional with a drive + * prefix ("c:") or use one of these URL schemata: + * + * file://<fname> + * + * This is the same as the default just with an explicit schemata. + * + * assuan://<ipaddr>:<port> + * assuan://[<ip6addr>]:<port> + * + * Connect using TCP to PORT of the server with the numerical + * IPADDR. Note that '[' and ']' are literal characters. + */ gpg_error_t assuan_socket_connect (assuan_context_t ctx, const char *name, pid_t server_pid, unsigned int flags) diff --git a/src/assuan.h.in b/src/assuan.h.in index 65d3b48..c4a7e82 100644 --- a/src/assuan.h.in +++ b/src/assuan.h.in @@ -21,6 +21,13 @@ * @configure_input@ */ +/* Compile time configuration: + * + * #define _ASSUAN_NO_SOCKET_WRAPPER + * + * Do not include the definitions for the socket wrapper feature. + */ + #ifndef ASSUAN_H #define ASSUAN_H @@ -37,13 +44,6 @@ #include <gpg-error.h> -/* Compile time configuration: - - #define _ASSUAN_NO_SOCKET_WRAPPER - - Do not include the definitions for the socket wrapper feature. */ - - #ifdef __cplusplus extern "C" { @@ -53,12 +53,12 @@ extern "C" #endif /* The version of this header should match the one of the library. Do - not use this symbol in your application; use assuan_check_version - instead. */ + * not use this symbol in your application; use assuan_check_version + * instead. */ #define ASSUAN_VERSION @version@ /* The version number of this header. It may be used to handle minor - API incompatibilities. */ + * API incompatibilities. */ #define ASSUAN_VERSION_NUMBER @version-number@ @@ -88,7 +88,9 @@ assuan_fd_t assuan_fdopen (int fd); @include:sock-nonce@ -/* Global interface. */ +/* + * Global interface. + */ struct assuan_malloc_hooks { @@ -107,8 +109,8 @@ typedef struct assuan_malloc_hooks *assuan_malloc_hooks_t; #define ASSUAN_LOG_CONTROL 8 /* If MSG is NULL, return true/false depending on if this category is - logged. This is used to probe before expensive log message - generation (buffer dumps). */ + * logged. This is used to probe before expensive log message + * generation (buffer dumps). */ typedef int (*assuan_log_cb_t) (assuan_context_t ctx, void *hook, unsigned int cat, const char *msg); @@ -137,7 +139,7 @@ void assuan_get_log_cb (assuan_log_cb_t *log_cb, void **log_cb_data); /* Create a new Assuan context. The initial parameters are all needed - in the creation of the context. */ + * in the creation of the context. */ gpg_error_t assuan_new_ext (assuan_context_t *ctx, gpg_err_source_t errsource, assuan_malloc_hooks_t malloc_hooks, assuan_log_cb_t log_cb, void *log_cb_data); @@ -149,7 +151,7 @@ gpg_error_t assuan_new (assuan_context_t *ctx); void assuan_release (assuan_context_t ctx); /* Release the memory at PTR using the allocation handler of the - context CTX. This is a convenience function. */ + * context CTX. This is a convenience function. */ void assuan_free (assuan_context_t ctx, void *ptr); @@ -164,33 +166,38 @@ void *assuan_get_pointer (assuan_context_t ctx); typedef unsigned int assuan_flag_t; /* When using a pipe server, by default Assuan will wait for the - forked process to die in assuan_release. In certain cases this - is not desirable. By setting this flag, the waitpid will be - skipped and the caller is responsible to cleanup a forked - process. */ + * forked process to die in assuan_release. In certain cases this + * is not desirable. By setting this flag, the waitpid will be + * skipped and the caller is responsible to cleanup a forked + * process. */ #define ASSUAN_NO_WAITPID 1 + /* This flag indicates whether Assuan logging is in confidential mode. You can use assuan_{begin,end}_condidential to change the mode. */ #define ASSUAN_CONFIDENTIAL 2 + /* This flag suppresses fix up of signal handlers for pipes. */ #define ASSUAN_NO_FIXSIGNALS 3 + /* This flag changes assuan_transact to return comment lines via the - status callback. The default is to skip comment lines. */ + * status callback. The default is to skip comment lines. */ #define ASSUAN_CONVEY_COMMENTS 4 + /* This flag disables logging for one context. */ #define ASSUAN_NO_LOGGING 5 + /* This flag forces a connection close. */ #define ASSUAN_FORCE_CLOSE 6 + /* For context CTX, set the flag FLAG to VALUE. Values for flags - are usually 1 or 0 but certain flags might allow for other values; - see the description of the type assuan_flag_t for details. */ + * are usually 1 or 0 but certain flags might allow for other values; + * see the description of the type assuan_flag_t for details. */ void assuan_set_flag (assuan_context_t ctx, assuan_flag_t flag, int value); /* Return the VALUE of FLAG in context CTX. */ int assuan_get_flag (assuan_context_t ctx, assuan_flag_t flag); - /* Same as assuan_set_flag (ctx, ASSUAN_CONFIDENTIAL, 1). */ void assuan_begin_confidential (assuan_context_t ctx); @@ -207,7 +214,7 @@ void assuan_end_confidential (assuan_context_t ctx); #define ASSUAN_IO_MONITOR_IGNORE 2 /* The IO monitor gets to see all I/O on the context, and can return - ASSUAN_IO_MONITOR_* bits to control actions on it. */ + * ASSUAN_IO_MONITOR_* bits to control actions on it. */ typedef unsigned int (*assuan_io_monitor_t) (assuan_context_t ctx, void *hook, int inout, const char *line, size_t linelen); @@ -216,7 +223,7 @@ typedef unsigned int (*assuan_io_monitor_t) (assuan_context_t ctx, void *hook, void assuan_set_io_monitor (assuan_context_t ctx, assuan_io_monitor_t io_monitor, void *hook_data); - +/* The system hooks. See assuan_set_system_hooks et al. */ #define ASSUAN_SYSTEM_HOOKS_VERSION 2 #define ASSUAN_SPAWN_DETACHED 128 struct assuan_system_hooks @@ -265,18 +272,21 @@ struct assuan_system_hooks }; typedef struct assuan_system_hooks *assuan_system_hooks_t; + -/* Configuration of the default log handler. */ +/* + * Configuration of the default log handler. + */ /* Set the prefix to be used at the start of a line emitted by assuan - on the log stream. The default is the empty string. Note, that - this function is not thread-safe and should in general be used - right at startup. */ + * on the log stream. The default is the empty string. Note, that + * this function is not thread-safe and should in general be used + * right at startup. */ void assuan_set_assuan_log_prefix (const char *text); /* Return a prefix to be used at the start of a line emitted by assuan - on the log stream. The default implementation returns the empty - string, i.e. "" */ + * on the log stream. The default implementation returns the empty + * string, i.e. "". */ const char *assuan_get_assuan_log_prefix (void); /* Global default log stream. */ @@ -286,6 +296,7 @@ void assuan_set_assuan_log_stream (FILE *fp); void assuan_set_log_stream (assuan_context_t ctx, FILE *fp); +/* The type for assuan command handlers. */ typedef gpg_error_t (*assuan_handler_t) (assuan_context_t, char *); /*-- assuan-handler.c --*/ @@ -294,7 +305,9 @@ gpg_error_t assuan_register_command (assuan_context_t ctx, assuan_handler_t handler, const char *help_string); gpg_error_t assuan_register_pre_cmd_notify (assuan_context_t ctx, - gpg_error_t (*fnc)(assuan_context_t, const char *cmd)); + gpg_error_t (*fnc)(assuan_context_t, + const char *cmd)); + gpg_error_t assuan_register_post_cmd_notify (assuan_context_t ctx, void (*fnc)(assuan_context_t, gpg_error_t)); @@ -328,10 +341,10 @@ gpg_error_t assuan_write_status (assuan_context_t ctx, const char *keyword, const char *text); /* Negotiate a file descriptor. If LINE contains "FD=N", returns N - assuming a local file descriptor. If LINE contains "FD" reads a - file descriptor via CTX and stores it in *RDF (the CTX must be - capable of passing file descriptors). Under W32 the returned FD is - a libc-type one. */ + * assuming a local file descriptor. If LINE contains "FD" reads a + * file descriptor via CTX and stores it in *RDF (the CTX must be + * capable of passing file descriptors). Under Windows the returned + * FD is a libc-type one. */ gpg_error_t assuan_command_parse_fd (assuan_context_t ctx, char *line, assuan_fd_t *rfd); @@ -397,7 +410,11 @@ gpg_error_t assuan_get_peercred (assuan_context_t ctx, -/* Client interface. */ +/* + * Client interface. + */ + +/* Client response codes. */ #define ASSUAN_RESPONSE_ERROR 0 #define ASSUAN_RESPONSE_OK 1 #define ASSUAN_RESPONSE_DATA 2 @@ -448,8 +465,8 @@ gpg_error_t assuan_send_data (assuan_context_t ctx, const void *buffer, size_t length); /* The file descriptor must be pending before assuan_receivefd is - called. This means that assuan_sendfd should be called *before* the - trigger is sent (normally via assuan_write_line ("INPUT FD")). */ + * called. This means that assuan_sendfd should be called *before* the + * trigger is sent (normally via assuan_write_line ("INPUT FD")). */ gpg_error_t assuan_sendfd (assuan_context_t ctx, assuan_fd_t fd); gpg_error_t assuan_receivefd (assuan_context_t ctx, assuan_fd_t *fd); @@ -463,15 +480,16 @@ gpg_error_t assuan_set_error (assuan_context_t ctx, gpg_error_t err, /*-- assuan-socket.c --*/ /* This flag is used with assuan_sock_connect_byname to - connect via SOCKS. */ + * connect via SOCKS. */ #define ASSUAN_SOCK_SOCKS 1 + /* This flag is used with assuan_sock_connect_byname to force a connection via Tor even if the socket subsystem has not been swicthed into Tor mode. This flags overrides ASSUAN_SOCK_SOCKS. */ #define ASSUAN_SOCK_TOR 2 /* These are socket wrapper functions to support an emulation of Unix - domain sockets on Windows W32. */ + * domain sockets on Windows. */ gpg_error_t assuan_sock_init (void); void assuan_sock_deinit (void); int assuan_sock_close (assuan_fd_t fd); @@ -522,7 +540,7 @@ int __assuan_recvmsg (assuan_context_t ctx, assuan_fd_t fd, assuan_msghdr_t msg, int __assuan_sendmsg (assuan_context_t ctx, assuan_fd_t fd, const assuan_msghdr_t msg, int flags); pid_t __assuan_waitpid (assuan_context_t ctx, pid_t pid, int nowait, int *status, int options); - +/* Standard system hooks for the legacy GNU Pth. */ #define ASSUAN_SYSTEM_PTH_IMPL \ static void _assuan_pth_usleep (assuan_context_t ctx, unsigned int usec) \ { (void) ctx; pth_usleep (usec); } \ @@ -549,6 +567,7 @@ pid_t __assuan_waitpid (assuan_context_t ctx, pid_t pid, int nowait, int *status extern struct assuan_system_hooks _assuan_system_pth; #define ASSUAN_SYSTEM_PTH &_assuan_system_pth +/* Standard system hooks for nPth. */ #define ASSUAN_SYSTEM_NPTH_IMPL \ static void _assuan_npth_usleep (assuan_context_t ctx, unsigned int usec) \ { npth_unprotect(); \ |