PostgreSQL Source Code  git master
libpq.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * libpq.h
4  * POSTGRES LIBPQ buffer structure definitions.
5  *
6  *
7  * Portions Copyright (c) 1996-2024, 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 ListenServerPort(int family, const char *hostName,
68  unsigned short portNumber, const char *unixSocketDir,
69  pgsocket ListenSocket[], int *NumListenSockets, int MaxListen);
70 extern int AcceptConnection(pgsocket server_fd, ClientSocket *client_sock);
71 extern void TouchSocketFiles(void);
72 extern void RemoveSocketFiles(void);
73 extern Port *pq_init(ClientSocket *client_sock);
74 extern int pq_getbytes(char *s, size_t len);
75 extern void pq_startmsgread(void);
76 extern void pq_endmsgread(void);
77 extern bool pq_is_reading_msg(void);
78 extern int pq_getmessage(StringInfo s, int maxlen);
79 extern int pq_getbyte(void);
80 extern int pq_peekbyte(void);
81 extern int pq_getbyte_if_available(unsigned char *c);
82 extern ssize_t pq_buffer_remaining_data(void);
83 extern int pq_putmessage_v2(char msgtype, const char *s, size_t len);
84 extern bool pq_check_connection(void);
85 
86 /*
87  * prototypes for functions in be-secure.c
88  */
89 extern PGDLLIMPORT char *ssl_library;
90 extern PGDLLIMPORT char *ssl_cert_file;
91 extern PGDLLIMPORT char *ssl_key_file;
92 extern PGDLLIMPORT char *ssl_ca_file;
93 extern PGDLLIMPORT char *ssl_crl_file;
94 extern PGDLLIMPORT char *ssl_crl_dir;
95 extern PGDLLIMPORT char *ssl_dh_params_file;
96 extern PGDLLIMPORT char *ssl_passphrase_command;
97 extern PGDLLIMPORT bool ssl_passphrase_command_supports_reload;
98 #ifdef USE_SSL
99 extern PGDLLIMPORT bool ssl_loaded_verify_locations;
100 #endif
101 
102 extern int secure_initialize(bool isServerStart);
103 extern bool secure_loaded_verify_locations(void);
104 extern void secure_destroy(void);
105 extern int secure_open_server(Port *port);
106 extern void secure_close(Port *port);
107 extern ssize_t secure_read(Port *port, void *ptr, size_t len);
108 extern ssize_t secure_write(Port *port, void *ptr, size_t len);
109 extern ssize_t secure_raw_read(Port *port, void *ptr, size_t len);
110 extern ssize_t secure_raw_write(Port *port, const void *ptr, size_t len);
111 
112 /*
113  * prototypes for functions in be-secure-gssapi.c
114  */
115 #ifdef ENABLE_GSS
116 extern ssize_t secure_open_gssapi(Port *port);
117 #endif
118 
119 /* GUCs */
120 extern PGDLLIMPORT char *SSLCipherSuites;
121 extern PGDLLIMPORT char *SSLECDHCurve;
122 extern PGDLLIMPORT bool SSLPreferServerCiphers;
123 extern PGDLLIMPORT int ssl_min_protocol_version;
124 extern PGDLLIMPORT int ssl_max_protocol_version;
125 
126 enum ssl_protocol_versions
127 {
128  PG_TLS_ANY = 0,
129  PG_TLS1_VERSION,
130  PG_TLS1_1_VERSION,
131  PG_TLS1_2_VERSION,
132  PG_TLS1_3_VERSION,
133 };
134 
135 /*
136  * prototypes for functions in be-secure-common.c
137  */
138 extern int run_ssl_passphrase_command(const char *prompt, bool is_server_start,
139  char *buf, int size);
140 extern bool check_ssl_key_file_permissions(const char *ssl_key_file,
141  bool isServerStart);
142 
143 #endif /* LIBPQ_H */
secure_open_gssapi
ssize_t secure_open_gssapi(Port *port)
Definition: be-secure-gssapi.c:495
PGDLLIMPORT
#define PGDLLIMPORT
Definition: c.h:1316
bool
unsigned char bool
Definition: c.h:456
ssl_ca_file
PGDLLIMPORT char * ssl_ca_file
Definition: be-secure.c:38
SSLCipherSuites
PGDLLIMPORT char * SSLCipherSuites
Definition: be-secure.c:50
secure_destroy
void secure_destroy(void)
Definition: be-secure.c:86
check_ssl_key_file_permissions
bool check_ssl_key_file_permissions(const char *ssl_key_file, bool isServerStart)
Definition: be-secure-common.c:110
ssl_dh_params_file
PGDLLIMPORT char * ssl_dh_params_file
Definition: be-secure.c:41
SSLECDHCurve
PGDLLIMPORT char * SSLECDHCurve
Definition: be-secure.c:53
ssl_max_protocol_version
PGDLLIMPORT int ssl_max_protocol_version
Definition: be-secure.c:59
ssl_library
PGDLLIMPORT char * ssl_library
Definition: be-secure.c:35
pq_peekbyte
int pq_peekbyte(void)
Definition: pqcomm.c:982
pq_getbyte_if_available
int pq_getbyte_if_available(unsigned char *c)
Definition: pqcomm.c:1003
secure_raw_read
ssize_t secure_raw_read(Port *port, void *ptr, size_t len)
Definition: be-secure.c:264
FeBeWaitSet
PGDLLIMPORT WaitEventSet * FeBeWaitSet
Definition: pqcomm.c:165
secure_initialize
int secure_initialize(bool isServerStart)
Definition: be-secure.c:73
ssl_protocol_versions
ssl_protocol_versions
Definition: libpq.h:127
PG_TLS1_VERSION
@ PG_TLS1_VERSION
Definition: libpq.h:129
PG_TLS1_3_VERSION
@ PG_TLS1_3_VERSION
Definition: libpq.h:132
PG_TLS1_1_VERSION
@ PG_TLS1_1_VERSION
Definition: libpq.h:130
PG_TLS1_2_VERSION
@ PG_TLS1_2_VERSION
Definition: libpq.h:131
PG_TLS_ANY
@ PG_TLS_ANY
Definition: libpq.h:128
ssl_key_file
PGDLLIMPORT char * ssl_key_file
Definition: be-secure.c:37
pq_getmessage
int pq_getmessage(StringInfo s, int maxlen)
Definition: pqcomm.c:1202
pq_getbytes
int pq_getbytes(char *s, size_t len)
Definition: pqcomm.c:1062
pq_init
Port * pq_init(ClientSocket *client_sock)
Definition: pqcomm.c:173
pq_buffer_remaining_data
ssize_t pq_buffer_remaining_data(void)
Definition: pqcomm.c:1126
run_ssl_passphrase_command
int run_ssl_passphrase_command(const char *prompt, bool is_server_start, char *buf, int size)
Definition: be-secure-common.c:40
secure_write
ssize_t secure_write(Port *port, void *ptr, size_t len)
Definition: be-secure.c:301
secure_open_server
int secure_open_server(Port *port)
Definition: be-secure.c:110
pq_endmsgread
void pq_endmsgread(void)
Definition: pqcomm.c:1164
secure_loaded_verify_locations
bool secure_loaded_verify_locations(void)
Definition: be-secure.c:97
AcceptConnection
int AcceptConnection(pgsocket server_fd, ClientSocket *client_sock)
Definition: pqcomm.c:793
TouchSocketFiles
void TouchSocketFiles(void)
Definition: pqcomm.c:829
pq_getbyte
int pq_getbyte(void)
Definition: pqcomm.c:963
ssl_min_protocol_version
PGDLLIMPORT int ssl_min_protocol_version
Definition: be-secure.c:58
secure_close
void secure_close(Port *port)
Definition: be-secure.c:163
secure_read
ssize_t secure_read(Port *port, void *ptr, size_t len)
Definition: be-secure.c:175
ssl_crl_dir
PGDLLIMPORT char * ssl_crl_dir
Definition: be-secure.c:40
ssl_cert_file
PGDLLIMPORT char * ssl_cert_file
Definition: be-secure.c:36
ListenServerPort
int ListenServerPort(int family, const char *hostName, unsigned short portNumber, const char *unixSocketDir, pgsocket ListenSocket[], int *NumListenSockets, int MaxListen)
Definition: pqcomm.c:417
PqCommMethods
const PGDLLIMPORT PQcommMethods * PqCommMethods
Definition: pqcomm.c:163
pq_putmessage_v2
int pq_putmessage_v2(char msgtype, const char *s, size_t len)
Definition: pqcomm.c:1558
ssl_crl_file
PGDLLIMPORT char * ssl_crl_file
Definition: be-secure.c:39
ssl_passphrase_command_supports_reload
PGDLLIMPORT bool ssl_passphrase_command_supports_reload
Definition: be-secure.c:43
secure_raw_write
ssize_t secure_raw_write(Port *port, const void *ptr, size_t len)
Definition: be-secure.c:373
pq_is_reading_msg
bool pq_is_reading_msg(void)
Definition: pqcomm.c:1180
RemoveSocketFiles
void RemoveSocketFiles(void)
Definition: pqcomm.c:847
pq_check_connection
bool pq_check_connection(void)
Definition: pqcomm.c:2053
SSLPreferServerCiphers
PGDLLIMPORT bool SSLPreferServerCiphers
Definition: be-secure.c:56
pq_startmsgread
void pq_startmsgread(void)
Definition: pqcomm.c:1140
ssl_passphrase_command
PGDLLIMPORT char * ssl_passphrase_command
Definition: be-secure.c:42
len
const void size_t len
Definition: pg_crc32c_sse42.c:24
port
static int port
Definition: pg_regress.c:116
buf
static char * buf
Definition: pg_test_fsync.c:73
pgsocket
int pgsocket
Definition: port.h:29
NumListenSockets
static int NumListenSockets
Definition: postmaster.c:221
c
char * c
Definition: preproc-cursor.c:31
size
static pg_noinline void Size size
Definition: slab.c:607
Port
Definition: libpq-be.h:133