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 ListenSockets[], 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 int secure_initialize(bool isServerStart);
90 extern bool secure_loaded_verify_locations(void);
91 extern void secure_destroy(void);
92 extern int secure_open_server(Port *port);
93 extern void secure_close(Port *port);
94 extern ssize_t secure_read(Port *port, void *ptr, size_t len);
95 extern ssize_t secure_write(Port *port, void *ptr, size_t len);
96 extern ssize_t secure_raw_read(Port *port, void *ptr, size_t len);
97 extern ssize_t secure_raw_write(Port *port, const void *ptr, size_t len);
98 
99 /*
100  * declarations for variables defined in be-secure.c
101  */
102 extern PGDLLIMPORT char *ssl_library;
103 extern PGDLLIMPORT char *ssl_ca_file;
104 extern PGDLLIMPORT char *ssl_cert_file;
105 extern PGDLLIMPORT char *ssl_crl_file;
106 extern PGDLLIMPORT char *ssl_crl_dir;
107 extern PGDLLIMPORT char *ssl_key_file;
108 extern PGDLLIMPORT int ssl_min_protocol_version;
109 extern PGDLLIMPORT int ssl_max_protocol_version;
110 extern PGDLLIMPORT char *ssl_passphrase_command;
111 extern PGDLLIMPORT bool ssl_passphrase_command_supports_reload;
112 extern PGDLLIMPORT char *ssl_dh_params_file;
113 extern PGDLLIMPORT char *SSLCipherSuites;
114 extern PGDLLIMPORT char *SSLCipherList;
115 extern PGDLLIMPORT char *SSLECDHCurve;
116 extern PGDLLIMPORT bool SSLPreferServerCiphers;
117 #ifdef USE_SSL
118 extern PGDLLIMPORT bool ssl_loaded_verify_locations;
119 #endif
120 
121 /*
122  * prototypes for functions in be-secure-gssapi.c
123  */
124 #ifdef ENABLE_GSS
125 extern ssize_t secure_open_gssapi(Port *port);
126 #endif
127 
128 enum ssl_protocol_versions
129 {
130  PG_TLS_ANY = 0,
131  PG_TLS1_VERSION,
132  PG_TLS1_1_VERSION,
133  PG_TLS1_2_VERSION,
134  PG_TLS1_3_VERSION,
135 };
136 
137 /*
138  * prototypes for functions in be-secure-common.c
139  */
140 extern int run_ssl_passphrase_command(const char *prompt, bool is_server_start,
141  char *buf, int size);
142 extern bool check_ssl_key_file_permissions(const char *ssl_key_file,
143  bool isServerStart);
144 
145 #endif /* LIBPQ_H */
secure_open_gssapi
ssize_t secure_open_gssapi(Port *port)
Definition: be-secure-gssapi.c:496
PGDLLIMPORT
#define PGDLLIMPORT
Definition: c.h:1295
ssl_ca_file
PGDLLIMPORT char * ssl_ca_file
Definition: be-secure.c:39
SSLCipherSuites
PGDLLIMPORT char * SSLCipherSuites
Definition: be-secure.c:51
secure_destroy
void secure_destroy(void)
Definition: be-secure.c:88
check_ssl_key_file_permissions
bool check_ssl_key_file_permissions(const char *ssl_key_file, bool isServerStart)
Definition: be-secure-common.c:114
ssl_dh_params_file
PGDLLIMPORT char * ssl_dh_params_file
Definition: be-secure.c:42
SSLECDHCurve
PGDLLIMPORT char * SSLECDHCurve
Definition: be-secure.c:55
ssl_max_protocol_version
PGDLLIMPORT int ssl_max_protocol_version
Definition: be-secure.c:61
ssl_library
PGDLLIMPORT char * ssl_library
Definition: be-secure.c:36
pq_peekbyte
int pq_peekbyte(void)
Definition: pqcomm.c:983
pq_getbyte_if_available
int pq_getbyte_if_available(unsigned char *c)
Definition: pqcomm.c:1004
secure_raw_read
ssize_t secure_raw_read(Port *port, void *ptr, size_t len)
Definition: be-secure.c:268
FeBeWaitSet
PGDLLIMPORT WaitEventSet * FeBeWaitSet
Definition: pqcomm.c:166
secure_initialize
int secure_initialize(bool isServerStart)
Definition: be-secure.c:75
ssl_protocol_versions
ssl_protocol_versions
Definition: libpq.h:129
PG_TLS1_VERSION
@ PG_TLS1_VERSION
Definition: libpq.h:131
PG_TLS1_3_VERSION
@ PG_TLS1_3_VERSION
Definition: libpq.h:134
PG_TLS1_1_VERSION
@ PG_TLS1_1_VERSION
Definition: libpq.h:132
PG_TLS1_2_VERSION
@ PG_TLS1_2_VERSION
Definition: libpq.h:133
PG_TLS_ANY
@ PG_TLS_ANY
Definition: libpq.h:130
ssl_key_file
PGDLLIMPORT char * ssl_key_file
Definition: be-secure.c:38
pq_getmessage
int pq_getmessage(StringInfo s, int maxlen)
Definition: pqcomm.c:1203
pq_getbytes
int pq_getbytes(char *s, size_t len)
Definition: pqcomm.c:1063
pq_init
Port * pq_init(ClientSocket *client_sock)
Definition: pqcomm.c:174
pq_buffer_remaining_data
ssize_t pq_buffer_remaining_data(void)
Definition: pqcomm.c:1127
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
SSLCipherList
PGDLLIMPORT char * SSLCipherList
Definition: be-secure.c:52
ListenServerPort
int ListenServerPort(int family, const char *hostName, unsigned short portNumber, const char *unixSocketDir, pgsocket ListenSockets[], int *NumListenSockets, int MaxListen)
Definition: pqcomm.c:418
secure_write
ssize_t secure_write(Port *port, void *ptr, size_t len)
Definition: be-secure.c:305
secure_open_server
int secure_open_server(Port *port)
Definition: be-secure.c:112
pq_endmsgread
void pq_endmsgread(void)
Definition: pqcomm.c:1165
secure_loaded_verify_locations
bool secure_loaded_verify_locations(void)
Definition: be-secure.c:99
AcceptConnection
int AcceptConnection(pgsocket server_fd, ClientSocket *client_sock)
Definition: pqcomm.c:794
TouchSocketFiles
void TouchSocketFiles(void)
Definition: pqcomm.c:830
pq_getbyte
int pq_getbyte(void)
Definition: pqcomm.c:964
ssl_min_protocol_version
PGDLLIMPORT int ssl_min_protocol_version
Definition: be-secure.c:60
secure_close
void secure_close(Port *port)
Definition: be-secure.c:167
secure_read
ssize_t secure_read(Port *port, void *ptr, size_t len)
Definition: be-secure.c:179
ssl_crl_dir
PGDLLIMPORT char * ssl_crl_dir
Definition: be-secure.c:41
ssl_cert_file
PGDLLIMPORT char * ssl_cert_file
Definition: be-secure.c:37
PqCommMethods
const PGDLLIMPORT PQcommMethods * PqCommMethods
Definition: pqcomm.c:164
pq_putmessage_v2
int pq_putmessage_v2(char msgtype, const char *s, size_t len)
Definition: pqcomm.c:1559
ssl_crl_file
PGDLLIMPORT char * ssl_crl_file
Definition: be-secure.c:40
ssl_passphrase_command_supports_reload
PGDLLIMPORT bool ssl_passphrase_command_supports_reload
Definition: be-secure.c:44
secure_raw_write
ssize_t secure_raw_write(Port *port, const void *ptr, size_t len)
Definition: be-secure.c:377
pq_is_reading_msg
bool pq_is_reading_msg(void)
Definition: pqcomm.c:1181
RemoveSocketFiles
void RemoveSocketFiles(void)
Definition: pqcomm.c:848
pq_check_connection
bool pq_check_connection(void)
Definition: pqcomm.c:2054
SSLPreferServerCiphers
PGDLLIMPORT bool SSLPreferServerCiphers
Definition: be-secure.c:58
pq_startmsgread
void pq_startmsgread(void)
Definition: pqcomm.c:1141
ssl_passphrase_command
PGDLLIMPORT char * ssl_passphrase_command
Definition: be-secure.c:43
len
const void size_t len
Definition: pg_crc32c_sse42.c:25
port
static int port
Definition: pg_regress.c:115
buf
static char * buf
Definition: pg_test_fsync.c:72
pgsocket
int pgsocket
Definition: port.h:29
ListenSockets
static pgsocket * ListenSockets
Definition: postmaster.c:227
NumListenSockets
static int NumListenSockets
Definition: postmaster.c:226
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