src/include/libpq/libpq.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * libpq.h
   4  *        POSTGRES LIBPQ buffer structure definitions.
   5  *
   6  *
   7  * Portions Copyright (c) 1996-2023, PostgreSQL Global Development Group
   8  * Portions Copyright (c) 1994, Regents of the University of California
   9  *
  10  * src/include/libpq/libpq.h
  11  *
  12  *-------------------------------------------------------------------------
  13  */
  14 #ifndef LIBPQ_H
  15 #define LIBPQ_H
  16
  17 #include <netinet/in.h>
  18
  19 #include "lib/stringinfo.h"
  20 #include "libpq/libpq-be.h"
  21 #include "storage/latch.h"
  22
  23
  24 /*
  25  * Callers of pq_getmessage() must supply a maximum expected message size.
  26  * By convention, if there's not any specific reason to use another value,
  27  * use PQ_SMALL_MESSAGE_LIMIT for messages that shouldn't be too long, and
  28  * PQ_LARGE_MESSAGE_LIMIT for messages that can be long.
  29  */
  30 #define PQ_SMALL_MESSAGE_LIMIT  10000
  31 #define PQ_LARGE_MESSAGE_LIMIT  (MaxAllocSize - 1)
  32
  33 typedef struct
  34 {
  35         void            (*comm_reset) (void);
  36         int                     (*flush) (void);
  37         int                     (*flush_if_writable) (void);
  38         bool            (*is_send_pending) (void);
  39         int                     (*putmessage) (char msgtype, const char *s, size_t len);
  40         void            (*putmessage_noblock) (char msgtype, const char *s, size_t len);
  41 } PQcommMethods;
  42
  43 extern const PGDLLIMPORT PQcommMethods *PqCommMethods;
  44
  45 #define pq_comm_reset() (PqCommMethods->comm_reset())
  46 #define pq_flush() (PqCommMethods->flush())
  47 #define pq_flush_if_writable() (PqCommMethods->flush_if_writable())
  48 #define pq_is_send_pending() (PqCommMethods->is_send_pending())
  49 #define pq_putmessage(msgtype, s, len) \
  50         (PqCommMethods->putmessage(msgtype, s, len))
  51 #define pq_putmessage_noblock(msgtype, s, len) \
  52         (PqCommMethods->putmessage_noblock(msgtype, s, len))
  53
  54 /*
  55  * External functions.
  56  */
  57
  58 /*
  59  * prototypes for functions in pqcomm.c
  60  */
  61 extern PGDLLIMPORT WaitEventSet *FeBeWaitSet;
  62
  63 #define FeBeWaitSetSocketPos 0
  64 #define FeBeWaitSetLatchPos 1
  65 #define FeBeWaitSetNEvents 3
  66
  67 extern int      StreamServerPort(int family, const char *hostName,
  68                                                          unsigned short portNumber, const char *unixSocketDir,
  69                                                          pgsocket ListenSocket[], int MaxListen);
  70 extern int      StreamConnection(pgsocket server_fd, Port *port);
  71 extern void StreamClose(pgsocket sock);
  72 extern void TouchSocketFiles(void);
  73 extern void RemoveSocketFiles(void);
  74 extern void pq_init(void);
  75 extern int      pq_getbytes(char *s, size_t len);
  76 extern void pq_startmsgread(void);
  77 extern void pq_endmsgread(void);
  78 extern bool pq_is_reading_msg(void);
  79 extern int      pq_getmessage(StringInfo s, int maxlen);
  80 extern int      pq_getbyte(void);
  81 extern int      pq_peekbyte(void);
  82 extern int      pq_getbyte_if_available(unsigned char *c);
  83 extern bool pq_buffer_has_data(void);
  84 extern int      pq_putmessage_v2(char msgtype, const char *s, size_t len);
  85 extern bool pq_check_connection(void);
  86
  87 /*
  88  * prototypes for functions in be-secure.c
  89  */
  90 extern PGDLLIMPORT char *ssl_library;
  91 extern PGDLLIMPORT char *ssl_cert_file;
  92 extern PGDLLIMPORT char *ssl_key_file;
  93 extern PGDLLIMPORT char *ssl_ca_file;
  94 extern PGDLLIMPORT char *ssl_crl_file;
  95 extern PGDLLIMPORT char *ssl_crl_dir;
  96 extern PGDLLIMPORT char *ssl_dh_params_file;
  97 extern PGDLLIMPORT char *ssl_passphrase_command;
  98 extern PGDLLIMPORT bool ssl_passphrase_command_supports_reload;
  99 #ifdef USE_SSL
 100 extern PGDLLIMPORT bool ssl_loaded_verify_locations;
 101 #endif
 102
 103 extern int      secure_initialize(bool isServerStart);
 104 extern bool secure_loaded_verify_locations(void);
 105 extern void secure_destroy(void);
 106 extern int      secure_open_server(Port *port);
 107 extern void secure_close(Port *port);
 108 extern ssize_t secure_read(Port *port, void *ptr, size_t len);
 109 extern ssize_t secure_write(Port *port, void *ptr, size_t len);
 110 extern ssize_t secure_raw_read(Port *port, void *ptr, size_t len);
 111 extern ssize_t secure_raw_write(Port *port, const void *ptr, size_t len);
 112
 113 /*
 114  * prototypes for functions in be-secure-gssapi.c
 115  */
 116 #ifdef ENABLE_GSS
 117 extern ssize_t secure_open_gssapi(Port *port);
 118 #endif
 119
 120 /* GUCs */
 121 extern PGDLLIMPORT char *SSLCipherSuites;
 122 extern PGDLLIMPORT char *SSLECDHCurve;
 123 extern PGDLLIMPORT bool SSLPreferServerCiphers;
 124 extern PGDLLIMPORT int ssl_min_protocol_version;
 125 extern PGDLLIMPORT int ssl_max_protocol_version;
 126
 127 enum ssl_protocol_versions
 128 {
 129         PG_TLS_ANY = 0,
 130         PG_TLS1_VERSION,
 131         PG_TLS1_1_VERSION,
 132         PG_TLS1_2_VERSION,
 133         PG_TLS1_3_VERSION,
 134 };
 135
 136 /*
 137  * prototypes for functions in be-secure-common.c
 138  */
 139 extern int      run_ssl_passphrase_command(const char *prompt, bool is_server_start,
 140                                                                            char *buf, int size);
 141 extern bool check_ssl_key_file_permissions(const char *ssl_key_file,
 142                                                                                    bool isServerStart);
 143
 144 #endif                                                  /* LIBPQ_H */