PostgreSQL Source Code  git master
libpq-int.h
Go to the documentation of this file.
1 /*-------------------------------------------------------------------------
2  *
3  * libpq-int.h
4  * This file contains internal definitions meant to be used only by
5  * the frontend libpq library, not by applications that call it.
6  *
7  * An application can include this file if it wants to bypass the
8  * official API defined by libpq-fe.h, but code that does so is much
9  * more likely to break across PostgreSQL releases than code that uses
10  * only the official API.
11  *
12  * Portions Copyright (c) 1996-2021, PostgreSQL Global Development Group
13  * Portions Copyright (c) 1994, Regents of the University of California
14  *
15  * src/interfaces/libpq/libpq-int.h
16  *
17  *-------------------------------------------------------------------------
18  */
19 
20 #ifndef LIBPQ_INT_H
21 #define LIBPQ_INT_H
22 
23 /* We assume libpq-fe.h has already been included. */
24 #include "libpq-events.h"
25 
26 #include <time.h>
27 #ifndef WIN32
28 #include <sys/time.h>
29 #endif
30 
31 #ifdef ENABLE_THREAD_SAFETY
32 #ifdef WIN32
33 #include "pthread-win32.h"
34 #else
35 #include <pthread.h>
36 #endif
37 #include <signal.h>
38 #endif
39 
40 /* include stuff common to fe and be */
41 #include "getaddrinfo.h"
42 #include "libpq/pqcomm.h"
43 /* include stuff found in fe only */
44 #include "pqexpbuffer.h"
45 
46 #ifdef ENABLE_GSS
47 #if defined(HAVE_GSSAPI_H)
48 #include <gssapi.h>
49 #else
50 #include <gssapi/gssapi.h>
51 #endif
52 #endif
53 
54 #ifdef ENABLE_SSPI
55 #define SECURITY_WIN32
56 #if defined(WIN32) && !defined(_MSC_VER)
57 #include <ntsecapi.h>
58 #endif
59 #include <security.h>
60 #undef SECURITY_WIN32
61 
62 #ifndef ENABLE_GSS
63 /*
64  * Define a fake structure compatible with GSSAPI on Unix.
65  */
66 typedef struct
67 {
68  void *value;
69  int length;
70 } gss_buffer_desc;
71 #endif
72 #endif /* ENABLE_SSPI */
73 
74 #ifdef USE_OPENSSL
75 #include <openssl/ssl.h>
76 #include <openssl/err.h>
77 
78 #ifndef OPENSSL_NO_ENGINE
79 #define USE_SSL_ENGINE
80 #endif
81 #endif /* USE_OPENSSL */
82 
83 /*
84  * POSTGRES backend dependent Constants.
85  */
86 #define CMDSTATUS_LEN 64 /* should match COMPLETION_TAG_BUFSIZE */
87 
88 /*
89  * PGresult and the subsidiary types PGresAttDesc, PGresAttValue
90  * represent the result of a query (or more precisely, of a single SQL
91  * command --- a query string given to PQexec can contain multiple commands).
92  * Note we assume that a single command can return at most one tuple group,
93  * hence there is no need for multiple descriptor sets.
94  */
95 
96 /* Subsidiary-storage management structure for PGresult.
97  * See space management routines in fe-exec.c for details.
98  * Note that space[k] refers to the k'th byte starting from the physical
99  * head of the block --- it's a union, not a struct!
100  */
102 
104 {
105  PGresult_data *next; /* link to next block, or NULL */
106  char space[1]; /* dummy for accessing block as bytes */
107 };
108 
109 /* Data about a single parameter of a prepared statement */
110 typedef struct pgresParamDesc
111 {
112  Oid typid; /* type id */
114 
115 /*
116  * Data for a single attribute of a single tuple
117  *
118  * We use char* for Attribute values.
119  *
120  * The value pointer always points to a null-terminated area; we add a
121  * null (zero) byte after whatever the backend sends us. This is only
122  * particularly useful for text values ... with a binary value, the
123  * value might have embedded nulls, so the application can't use C string
124  * operators on it. But we add a null anyway for consistency.
125  * Note that the value itself does not contain a length word.
126  *
127  * A NULL attribute is a special case in two ways: its len field is NULL_LEN
128  * and its value field points to null_field in the owning PGresult. All the
129  * NULL attributes in a query result point to the same place (there's no need
130  * to store a null string separately for each one).
131  */
132 
133 #define NULL_LEN (-1) /* pg_result len for NULL value */
134 
135 typedef struct pgresAttValue
136 {
137  int len; /* length in bytes of the value */
138  char *value; /* actual value, plus terminating zero byte */
139 } PGresAttValue;
140 
141 /* Typedef for message-field list entries */
142 typedef struct pgMessageField
143 {
144  struct pgMessageField *next; /* list link */
145  char code; /* field code */
146  char contents[FLEXIBLE_ARRAY_MEMBER]; /* value, nul-terminated */
148 
149 /* Fields needed for notice handling */
150 typedef struct
151 {
152  PQnoticeReceiver noticeRec; /* notice message receiver */
154  PQnoticeProcessor noticeProc; /* notice message processor */
156 } PGNoticeHooks;
157 
158 typedef struct PGEvent
159 {
160  PGEventProc proc; /* the function to call on events */
161  char *name; /* used only for error messages */
162  void *passThrough; /* pointer supplied at registration time */
163  void *data; /* optional state (instance) data */
164  bool resultInitialized; /* T if RESULTCREATE/COPY succeeded */
165 } PGEvent;
166 
167 struct pg_result
168 {
169  int ntups;
172  PGresAttValue **tuples; /* each PGresult tuple is an array of
173  * PGresAttValue's */
174  int tupArrSize; /* allocated size of tuples array */
178  char cmdStatus[CMDSTATUS_LEN]; /* cmd status from the query */
179  int binary; /* binary tuple values if binary == 1,
180  * otherwise text */
181 
182  /*
183  * These fields are copied from the originating PGconn, so that operations
184  * on the PGresult don't have to reference the PGconn.
185  */
188  int nEvents;
189  int client_encoding; /* encoding id */
190 
191  /*
192  * Error information (all NULL if not an error result). errMsg is the
193  * "overall" error message returned by PQresultErrorMessage. If we have
194  * per-field info then it is stored in a linked list.
195  */
196  char *errMsg; /* error message, or NULL if no error */
197  PGMessageField *errFields; /* message broken into fields */
198  char *errQuery; /* text of triggering query, if available */
199 
200  /* All NULL attributes in the query result point to this null string */
201  char null_field[1];
202 
203  /*
204  * Space management information. Note that attDescs and error stuff, if
205  * not null, point into allocated blocks. But tuples points to a
206  * separately malloc'd block, so that we can realloc it.
207  */
208  PGresult_data *curBlock; /* most recently allocated block */
209  int curOffset; /* start offset of free space in block */
210  int spaceLeft; /* number of free bytes remaining in block */
211 
212  size_t memorySize; /* total space allocated for this PGresult */
213 };
214 
215 /* PGAsyncStatusType defines the state of the query-execution state machine */
216 typedef enum
217 {
218  PGASYNC_IDLE, /* nothing's happening, dude */
219  PGASYNC_BUSY, /* query in progress */
220  PGASYNC_READY, /* result ready for PQgetResult */
221  PGASYNC_COPY_IN, /* Copy In data transfer in progress */
222  PGASYNC_COPY_OUT, /* Copy Out data transfer in progress */
223  PGASYNC_COPY_BOTH /* Copy In/Out data transfer in progress */
225 
226 /* PGQueryClass tracks which query protocol we are now executing */
227 typedef enum
228 {
229  PGQUERY_SIMPLE, /* simple Query protocol (PQexec) */
230  PGQUERY_EXTENDED, /* full Extended protocol (PQexecParams) */
231  PGQUERY_PREPARE, /* Parse only (PQprepare) */
232  PGQUERY_DESCRIBE /* Describe Statement or Portal */
233 } PGQueryClass;
234 
235 /* Target server type (decoded value of target_session_attrs) */
236 typedef enum
237 {
238  SERVER_TYPE_ANY = 0, /* Any server (default) */
239  SERVER_TYPE_READ_WRITE, /* Read-write server */
240  SERVER_TYPE_READ_ONLY, /* Read-only server */
241  SERVER_TYPE_PRIMARY, /* Primary server */
242  SERVER_TYPE_STANDBY, /* Standby server */
243  SERVER_TYPE_PREFER_STANDBY, /* Prefer standby server */
244  SERVER_TYPE_PREFER_STANDBY_PASS2 /* second pass - behaves same as ANY */
246 
247 /* Boolean value plus a not-known state, for GUCs we might have to fetch */
248 typedef enum
249 {
250  PG_BOOL_UNKNOWN = 0, /* Currently unknown */
251  PG_BOOL_YES, /* Yes (true) */
252  PG_BOOL_NO /* No (false) */
253 } PGTernaryBool;
254 
255 /* Typedef for the EnvironmentOptions[] array */
256 typedef struct PQEnvironmentOption
257 {
258  const char *envName, /* name of an environment variable */
259  *pgName; /* name of corresponding SET variable */
261 
262 /* Typedef for parameter-status list entries */
263 typedef struct pgParameterStatus
264 {
265  struct pgParameterStatus *next; /* list link */
266  char *name; /* parameter name */
267  char *value; /* parameter value */
268  /* Note: name and value are stored in same malloc block as struct is */
270 
271 /* large-object-access data ... allocated only if large-object code is used. */
272 typedef struct pgLobjfuncs
273 {
274  Oid fn_lo_open; /* OID of backend function lo_open */
275  Oid fn_lo_close; /* OID of backend function lo_close */
276  Oid fn_lo_creat; /* OID of backend function lo_creat */
277  Oid fn_lo_create; /* OID of backend function lo_create */
278  Oid fn_lo_unlink; /* OID of backend function lo_unlink */
279  Oid fn_lo_lseek; /* OID of backend function lo_lseek */
280  Oid fn_lo_lseek64; /* OID of backend function lo_lseek64 */
281  Oid fn_lo_tell; /* OID of backend function lo_tell */
282  Oid fn_lo_tell64; /* OID of backend function lo_tell64 */
283  Oid fn_lo_truncate; /* OID of backend function lo_truncate */
284  Oid fn_lo_truncate64; /* OID of function lo_truncate64 */
285  Oid fn_lo_read; /* OID of backend function LOread */
286  Oid fn_lo_write; /* OID of backend function LOwrite */
287 } PGlobjfuncs;
288 
289 /* PGdataValue represents a data field value being passed to a row processor.
290  * It could be either text or binary data; text data is not zero-terminated.
291  * A SQL NULL is represented by len < 0; then value is still valid but there
292  * are no data bytes there.
293  */
294 typedef struct pgDataValue
295 {
296  int len; /* data length in bytes, or <0 if NULL */
297  const char *value; /* data value, without zero-termination */
298 } PGdataValue;
299 
300 /* Host address type enum for struct pg_conn_host */
301 typedef enum pg_conn_host_type
302 {
307 
308 /*
309  * pg_conn_host stores all information about each of possibly several hosts
310  * mentioned in the connection string. Most fields are derived by splitting
311  * the relevant connection parameter (e.g., pghost) at commas.
312  */
313 typedef struct pg_conn_host
314 {
315  pg_conn_host_type type; /* type of host address */
316  char *host; /* host name or socket path */
317  char *hostaddr; /* host numeric IP address */
318  char *port; /* port number (always provided) */
319  char *password; /* password for this host, read from the
320  * password file; NULL if not sought or not
321  * found in password file. */
322 } pg_conn_host;
323 
324 /*
325  * PGconn stores all the state data associated with a single connection
326  * to a backend.
327  */
328 struct pg_conn
329 {
330  /* Saved values of connection options */
331  char *pghost; /* the machine on which the server is running,
332  * or a path to a UNIX-domain socket, or a
333  * comma-separated list of machines and/or
334  * paths; if NULL, use DEFAULT_PGSOCKET_DIR */
335  char *pghostaddr; /* the numeric IP address of the machine on
336  * which the server is running, or a
337  * comma-separated list of same. Takes
338  * precedence over pghost. */
339  char *pgport; /* the server's communication port number, or
340  * a comma-separated list of ports */
341  char *pgtty; /* tty on which the backend messages is
342  * displayed (OBSOLETE, NOT USED) */
343  char *connect_timeout; /* connection timeout (numeric string) */
344  char *pgtcp_user_timeout; /* tcp user timeout (numeric string) */
345  char *client_encoding_initial; /* encoding to use */
346  char *pgoptions; /* options to start the backend with */
347  char *appname; /* application name */
348  char *fbappname; /* fallback application name */
349  char *dbName; /* database name */
350  char *replication; /* connect as the replication standby? */
351  char *pguser; /* Postgres username and password, if any */
352  char *pgpass;
353  char *pgpassfile; /* path to a file containing password(s) */
354  char *channel_binding; /* channel binding mode
355  * (require,prefer,disable) */
356  char *keepalives; /* use TCP keepalives? */
357  char *keepalives_idle; /* time between TCP keepalives */
358  char *keepalives_interval; /* time between TCP keepalive
359  * retransmits */
360  char *keepalives_count; /* maximum number of TCP keepalive
361  * retransmits */
362  char *sslmode; /* SSL mode (require,prefer,allow,disable) */
363  char *sslcompression; /* SSL compression (0 or 1) */
364  char *sslkey; /* client key filename */
365  char *sslcert; /* client certificate filename */
366  char *sslpassword; /* client key file password */
367  char *sslrootcert; /* root certificate filename */
368  char *sslcrl; /* certificate revocation list filename */
369  char *sslcrldir; /* certificate revocation list directory name */
370  char *requirepeer; /* required peer credentials for local sockets */
371  char *gssencmode; /* GSS mode (require,prefer,disable) */
372  char *krbsrvname; /* Kerberos service name */
373  char *gsslib; /* What GSS library to use ("gssapi" or
374  * "sspi") */
375  char *ssl_min_protocol_version; /* minimum TLS protocol version */
376  char *ssl_max_protocol_version; /* maximum TLS protocol version */
377  char *target_session_attrs; /* desired session properties */
378 
379  /* Optional file to write trace info to */
380  FILE *Pfdebug;
381 
382  /* Callback procedures for notice message processing */
384 
385  /* Event procs registered via PQregisterEventProc */
386  PGEvent *events; /* expandable array of event data */
387  int nEvents; /* number of active events */
388  int eventArraySize; /* allocated array size */
389 
390  /* Status indicators */
393  PGTransactionStatusType xactStatus; /* never changes to ACTIVE */
395  char *last_query; /* last SQL command, or NULL if unknown */
396  char last_sqlstate[6]; /* last reported SQLSTATE */
397  bool options_valid; /* true if OK to attempt connection */
398  bool nonblocking; /* whether this connection is using nonblock
399  * sending semantics */
400  bool singleRowMode; /* return current query result row-by-row? */
401  char copy_is_binary; /* 1 = copy binary, 0 = copy text */
402  int copy_already_done; /* # bytes already returned in COPY OUT */
403  PGnotify *notifyHead; /* oldest unreported Notify msg */
404  PGnotify *notifyTail; /* newest unreported Notify msg */
405 
406  /* Support for multiple hosts in connection string */
407  int nconnhost; /* # of hosts named in conn string */
408  int whichhost; /* host we're currently trying/connected to */
409  pg_conn_host *connhost; /* details about each named host */
410  char *connip; /* IP address for current network connection */
411 
412  /* Connection data */
413  pgsocket sock; /* FD for socket, PGINVALID_SOCKET if
414  * unconnected */
415  SockAddr laddr; /* Local address */
416  SockAddr raddr; /* Remote address */
417  ProtocolVersion pversion; /* FE/BE protocol version in use */
418  int sversion; /* server version, e.g. 70401 for 7.4.1 */
419  bool auth_req_received; /* true if any type of auth req received */
420  bool password_needed; /* true if server demanded a password */
421  bool sigpipe_so; /* have we masked SIGPIPE via SO_NOSIGPIPE? */
422  bool sigpipe_flag; /* can we mask SIGPIPE via MSG_NOSIGNAL? */
423  bool write_failed; /* have we had a write failure on sock? */
424  char *write_err_msg; /* write error message, or NULL if OOM */
425 
426  /* Transient state needed while establishing connection */
427  PGTargetServerType target_server_type; /* desired session properties */
428  bool try_next_addr; /* time to advance to next address/host? */
429  bool try_next_host; /* time to advance to next connhost[]? */
430  struct addrinfo *addrlist; /* list of addresses for current connhost */
431  struct addrinfo *addr_cur; /* the one currently being tried */
432  int addrlist_family; /* needed to know how to free addrlist */
433  bool send_appname; /* okay to send application_name? */
434 
435  /* Miscellaneous stuff */
436  int be_pid; /* PID of backend --- needed for cancels */
437  int be_key; /* key of backend --- needed for cancels */
438  pgParameterStatus *pstatus; /* ParameterStatus data */
439  int client_encoding; /* encoding id */
440  bool std_strings; /* standard_conforming_strings */
441  PGTernaryBool default_transaction_read_only; /* default_transaction_read_only */
442  PGTernaryBool in_hot_standby; /* in_hot_standby */
443  PGVerbosity verbosity; /* error/notice message verbosity */
444  PGContextVisibility show_context; /* whether to show CONTEXT field */
445  PGlobjfuncs *lobjfuncs; /* private state for large-object access fns */
446 
447  /* Buffer for data received from backend and not yet processed */
448  char *inBuffer; /* currently allocated buffer */
449  int inBufSize; /* allocated size of buffer */
450  int inStart; /* offset to first unconsumed data in buffer */
451  int inCursor; /* next byte to tentatively consume */
452  int inEnd; /* offset to first position after avail data */
453 
454  /* Buffer for data not yet sent to backend */
455  char *outBuffer; /* currently allocated buffer */
456  int outBufSize; /* allocated size of buffer */
457  int outCount; /* number of chars waiting in buffer */
458 
459  /* State for constructing messages in outBuffer */
460  int outMsgStart; /* offset to msg start (length word); if -1,
461  * msg has no length word */
462  int outMsgEnd; /* offset to msg end (so far) */
463 
464  /* Row processor interface workspace */
465  PGdataValue *rowBuf; /* array for passing values to rowProcessor */
466  int rowBufLen; /* number of entries allocated in rowBuf */
467 
468  /* Status for asynchronous result construction */
469  PGresult *result; /* result being constructed */
470  PGresult *next_result; /* next result (used in single-row mode) */
471 
472  /* Assorted state for SASL, SSL, GSS, etc */
473  void *sasl_state;
474 
475  /* SSL structures */
477 
478 #ifdef USE_SSL
479  bool allow_ssl_try; /* Allowed to try SSL negotiation */
480  bool wait_ssl_try; /* Delay SSL negotiation until after
481  * attempting normal connection */
482 #ifdef USE_OPENSSL
483  SSL *ssl; /* SSL status, if have SSL connection */
484  X509 *peer; /* X509 cert of server */
485 #ifdef USE_SSL_ENGINE
486  ENGINE *engine; /* SSL engine, if any */
487 #else
488  void *engine; /* dummy field to keep struct the same if
489  * OpenSSL version changes */
490 #endif
491 #endif /* USE_OPENSSL */
492 #endif /* USE_SSL */
493 
494 #ifdef ENABLE_GSS
495  gss_ctx_id_t gctx; /* GSS context */
496  gss_name_t gtarg_nam; /* GSS target name */
497 
498  /* The following are encryption-only */
499  bool try_gss; /* GSS attempting permitted */
500  bool gssenc; /* GSS encryption is usable */
501  gss_cred_id_t gcred; /* GSS credential temp storage. */
502 
503  /* GSS encryption I/O state --- see fe-secure-gssapi.c */
504  char *gss_SendBuffer; /* Encrypted data waiting to be sent */
505  int gss_SendLength; /* End of data available in gss_SendBuffer */
506  int gss_SendNext; /* Next index to send a byte from
507  * gss_SendBuffer */
508  int gss_SendConsumed; /* Number of *unencrypted* bytes consumed
509  * for current contents of gss_SendBuffer */
510  char *gss_RecvBuffer; /* Received, encrypted data */
511  int gss_RecvLength; /* End of data available in gss_RecvBuffer */
512  char *gss_ResultBuffer; /* Decryption of data in gss_RecvBuffer */
513  int gss_ResultLength; /* End of data available in
514  * gss_ResultBuffer */
515  int gss_ResultNext; /* Next index to read a byte from
516  * gss_ResultBuffer */
517  uint32 gss_MaxPktSize; /* Maximum size we can encrypt and fit the
518  * results into our output buffer */
519 #endif
520 
521 #ifdef ENABLE_SSPI
522  CredHandle *sspicred; /* SSPI credentials handle */
523  CtxtHandle *sspictx; /* SSPI context */
524  char *sspitarget; /* SSPI target name */
525  int usesspi; /* Indicate if SSPI is in use on the
526  * connection */
527 #endif
528 
529  /*
530  * Buffer for current error message. This is cleared at the start of any
531  * connection attempt or query cycle; after that, all code should append
532  * messages to it, never overwrite.
533  */
534  PQExpBufferData errorMessage; /* expansible string */
535 
536  /* Buffer for receiving various parts of messages */
537  PQExpBufferData workBuffer; /* expansible string */
538 };
539 
540 /* PGcancel stores all data necessary to cancel a connection. A copy of this
541  * data is required to safely cancel a connection running on a different
542  * thread.
543  */
544 struct pg_cancel
545 {
546  SockAddr raddr; /* Remote address */
547  int be_pid; /* PID of backend --- needed for cancels */
548  int be_key; /* key of backend --- needed for cancels */
549 };
550 
551 
552 /* String descriptions of the ExecStatusTypes.
553  * direct use of this array is deprecated; call PQresStatus() instead.
554  */
555 extern char *const pgresStatus[];
556 
557 
558 #ifdef USE_SSL
559 
560 #ifndef WIN32
561 #define USER_CERT_FILE ".postgresql/postgresql.crt"
562 #define USER_KEY_FILE ".postgresql/postgresql.key"
563 #define ROOT_CERT_FILE ".postgresql/root.crt"
564 #define ROOT_CRL_FILE ".postgresql/root.crl"
565 #else
566 /* On Windows, the "home" directory is already PostgreSQL-specific */
567 #define USER_CERT_FILE "postgresql.crt"
568 #define USER_KEY_FILE "postgresql.key"
569 #define ROOT_CERT_FILE "root.crt"
570 #define ROOT_CRL_FILE "root.crl"
571 #endif
572 
573 #endif /* USE_SSL */
574 
575 /* ----------------
576  * Internal functions of libpq
577  * Functions declared here need to be visible across files of libpq,
578  * but are not intended to be called by applications. We use the
579  * convention "pqXXX" for internal functions, vs. the "PQxxx" names
580  * used for application-visible routines.
581  * ----------------
582  */
583 
584 /* === in fe-connect.c === */
585 
586 extern void pqDropConnection(PGconn *conn, bool flushInput);
587 extern int pqPacketSend(PGconn *conn, char pack_type,
588  const void *buf, size_t buf_len);
589 extern bool pqGetHomeDirectory(char *buf, int bufsize);
590 
591 #ifdef ENABLE_THREAD_SAFETY
593 
594 #define PGTHREAD_ERROR(msg) \
595  do { \
596  fprintf(stderr, "%s\n", msg); \
597  abort(); \
598  } while (0)
599 
600 
601 #define pglock_thread() pg_g_threadlock(true)
602 #define pgunlock_thread() pg_g_threadlock(false)
603 #else
604 #define pglock_thread() ((void) 0)
605 #define pgunlock_thread() ((void) 0)
606 #endif
607 
608 /* === in fe-exec.c === */
609 
610 extern void pqSetResultError(PGresult *res, const char *msg);
611 extern void *pqResultAlloc(PGresult *res, size_t nBytes, bool isBinary);
612 extern char *pqResultStrdup(PGresult *res, const char *str);
613 extern void pqClearAsyncResult(PGconn *conn);
614 extern void pqSaveErrorResult(PGconn *conn);
616 extern void pqInternalNotice(const PGNoticeHooks *hooks, const char *fmt,...) pg_attribute_printf(2, 3);
617 extern void pqSaveMessageField(PGresult *res, char code,
618  const char *value);
619 extern void pqSaveParameterStatus(PGconn *conn, const char *name,
620  const char *value);
621 extern int pqRowProcessor(PGconn *conn, const char **errmsgp);
622 extern int PQsendQueryContinue(PGconn *conn, const char *query);
623 
624 /* === in fe-protocol3.c === */
625 
626 extern char *pqBuildStartupPacket3(PGconn *conn, int *packetlen,
628 extern void pqParseInput3(PGconn *conn);
629 extern int pqGetErrorNotice3(PGconn *conn, bool isError);
630 extern void pqBuildErrorMessage3(PQExpBuffer msg, const PGresult *res,
631  PGVerbosity verbosity, PGContextVisibility show_context);
632 extern int pqGetCopyData3(PGconn *conn, char **buffer, int async);
633 extern int pqGetline3(PGconn *conn, char *s, int maxlen);
634 extern int pqGetlineAsync3(PGconn *conn, char *buffer, int bufsize);
635 extern int pqEndcopy3(PGconn *conn);
636 extern PGresult *pqFunctionCall3(PGconn *conn, Oid fnid,
637  int *result_buf, int *actual_result_len,
638  int result_is_int,
639  const PQArgBlock *args, int nargs);
640 
641 /* === in fe-misc.c === */
642 
643  /*
644  * "Get" and "Put" routines return 0 if successful, EOF if not. Note that for
645  * Get, EOF merely means the buffer is exhausted, not that there is
646  * necessarily any error.
647  */
648 extern int pqCheckOutBufferSpace(size_t bytes_needed, PGconn *conn);
649 extern int pqCheckInBufferSpace(size_t bytes_needed, PGconn *conn);
650 extern int pqGetc(char *result, PGconn *conn);
651 extern int pqPutc(char c, PGconn *conn);
652 extern int pqGets(PQExpBuffer buf, PGconn *conn);
653 extern int pqGets_append(PQExpBuffer buf, PGconn *conn);
654 extern int pqPuts(const char *s, PGconn *conn);
655 extern int pqGetnchar(char *s, size_t len, PGconn *conn);
656 extern int pqSkipnchar(size_t len, PGconn *conn);
657 extern int pqPutnchar(const char *s, size_t len, PGconn *conn);
658 extern int pqGetInt(int *result, size_t bytes, PGconn *conn);
659 extern int pqPutInt(int value, size_t bytes, PGconn *conn);
660 extern int pqPutMsgStart(char msg_type, PGconn *conn);
661 extern int pqPutMsgEnd(PGconn *conn);
662 extern int pqReadData(PGconn *conn);
663 extern int pqFlush(PGconn *conn);
664 extern int pqWait(int forRead, int forWrite, PGconn *conn);
665 extern int pqWaitTimed(int forRead, int forWrite, PGconn *conn,
666  time_t finish_time);
667 extern int pqReadReady(PGconn *conn);
668 extern int pqWriteReady(PGconn *conn);
669 
670 /* === in fe-secure.c === */
671 
672 extern int pqsecure_initialize(PGconn *);
674 extern void pqsecure_close(PGconn *);
675 extern ssize_t pqsecure_read(PGconn *, void *ptr, size_t len);
676 extern ssize_t pqsecure_write(PGconn *, const void *ptr, size_t len);
677 extern ssize_t pqsecure_raw_read(PGconn *, void *ptr, size_t len);
678 extern ssize_t pqsecure_raw_write(PGconn *, const void *ptr, size_t len);
679 
680 #if defined(ENABLE_THREAD_SAFETY) && !defined(WIN32)
681 extern int pq_block_sigpipe(sigset_t *osigset, bool *sigpipe_pending);
682 extern void pq_reset_sigpipe(sigset_t *osigset, bool sigpipe_pending,
683  bool got_epipe);
684 #endif
685 
686 /* === SSL === */
687 
688 /*
689  * The SSL implementation provides these functions.
690  */
691 
692 /*
693  * Implementation of PQinitSSL().
694  */
695 extern void pgtls_init_library(bool do_ssl, int do_crypto);
696 
697 /*
698  * Initialize SSL library.
699  *
700  * The conn parameter is only used to be able to pass back an error
701  * message - no connection-local setup is made here.
702  *
703  * Returns 0 if OK, -1 on failure (adding a message to conn->errorMessage).
704  */
705 extern int pgtls_init(PGconn *conn);
706 
707 /*
708  * Begin or continue negotiating a secure session.
709  */
710 extern PostgresPollingStatusType pgtls_open_client(PGconn *conn);
711 
712 /*
713  * Close SSL connection.
714  */
715 extern void pgtls_close(PGconn *conn);
716 
717 /*
718  * Read data from a secure connection.
719  *
720  * On failure, this function is responsible for appending a suitable message
721  * to conn->errorMessage. The caller must still inspect errno, but only
722  * to determine whether to continue/retry after error.
723  */
724 extern ssize_t pgtls_read(PGconn *conn, void *ptr, size_t len);
725 
726 /*
727  * Is there unread data waiting in the SSL read buffer?
728  */
729 extern bool pgtls_read_pending(PGconn *conn);
730 
731 /*
732  * Write data to a secure connection.
733  *
734  * On failure, this function is responsible for appending a suitable message
735  * to conn->errorMessage. The caller must still inspect errno, but only
736  * to determine whether to continue/retry after error.
737  */
738 extern ssize_t pgtls_write(PGconn *conn, const void *ptr, size_t len);
739 
740 /*
741  * Get the hash of the server certificate, for SCRAM channel binding type
742  * tls-server-end-point.
743  *
744  * NULL is sent back to the caller in the event of an error, with an
745  * error message for the caller to consume.
746  *
747  * This is not supported with old versions of OpenSSL that don't have
748  * the X509_get_signature_nid() function.
749  */
750 #if defined(USE_OPENSSL) && defined(HAVE_X509_GET_SIGNATURE_NID)
751 #define HAVE_PGTLS_GET_PEER_CERTIFICATE_HASH
752 extern char *pgtls_get_peer_certificate_hash(PGconn *conn, size_t *len);
753 #endif
754 
755 /*
756  * Verify that the server certificate matches the host name we connected to.
757  *
758  * The certificate's Common Name and Subject Alternative Names are considered.
759  *
760  * Returns 1 if the name matches, and 0 if it does not. On error, returns
761  * -1, and sets the libpq error message.
762  *
763  */
765  int *names_examined,
766  char **first_name);
767 
768 /* === GSSAPI === */
769 
770 #ifdef ENABLE_GSS
771 
772 /*
773  * Establish a GSSAPI-encrypted connection.
774  */
775 extern PostgresPollingStatusType pqsecure_open_gss(PGconn *conn);
776 
777 /*
778  * Read and write functions for GSSAPI-encrypted connections, with internal
779  * buffering to handle nonblocking sockets.
780  */
781 extern ssize_t pg_GSS_write(PGconn *conn, const void *ptr, size_t len);
782 extern ssize_t pg_GSS_read(PGconn *conn, void *ptr, size_t len);
783 #endif
784 
785 /* === miscellaneous macros === */
786 
787 /*
788  * this is so that we can check if a connection is non-blocking internally
789  * without the overhead of a function call
790  */
791 #define pqIsnonblocking(conn) ((conn)->nonblocking)
792 
793 #ifdef ENABLE_NLS
794 extern char *libpq_gettext(const char *msgid) pg_attribute_format_arg(1);
795 extern char *libpq_ngettext(const char *msgid, const char *msgid_plural, unsigned long n) pg_attribute_format_arg(1) pg_attribute_format_arg(2);
796 #else
797 #define libpq_gettext(x) (x)
798 #define libpq_ngettext(s, p, n) ((n) == 1 ? (s) : (p))
799 #endif
800 
801 /*
802  * These macros are needed to let error-handling code be portable between
803  * Unix and Windows. (ugh)
804  */
805 #ifdef WIN32
806 #define SOCK_ERRNO (WSAGetLastError())
807 #define SOCK_STRERROR winsock_strerror
808 #define SOCK_ERRNO_SET(e) WSASetLastError(e)
809 #else
810 #define SOCK_ERRNO errno
811 #define SOCK_STRERROR strerror_r
812 #define SOCK_ERRNO_SET(e) (errno = (e))
813 #endif
814 
815 #endif /* LIBPQ_INT_H */
struct PGEvent PGEvent
struct pgDataValue PGdataValue
int pqPutInt(int value, size_t bytes, PGconn *conn)
Definition: fe-misc.c:293
PGContextVisibility show_context
Definition: libpq-int.h:444
bool sigpipe_flag
Definition: libpq-int.h:422
ConnStatusType
Definition: libpq-fe.h:47
size_t memorySize
Definition: libpq-int.h:212
char * gssencmode
Definition: libpq-int.h:371
void(* PQnoticeReceiver)(void *arg, const PGresult *res)
Definition: libpq-fe.h:173
void pgtls_close(PGconn *conn)
int inEnd
Definition: libpq-int.h:452
int pqPutMsgStart(char msg_type, PGconn *conn)
Definition: fe-misc.c:501
int pqWait(int forRead, int forWrite, PGconn *conn)
Definition: fe-misc.c:1026
PGMessageField * errFields
Definition: libpq-int.h:197
bool pgtls_read_pending(PGconn *conn)
int pqPacketSend(PGconn *conn, char pack_type, const void *buf, size_t buf_len)
Definition: fe-connect.c:4545
int inStart
Definition: libpq-int.h:450
ssize_t pgtls_read(PGconn *conn, void *ptr, size_t len)
char space[1]
Definition: libpq-int.h:106
int pqReadData(PGconn *conn)
Definition: fe-misc.c:606
char * pqBuildStartupPacket3(PGconn *conn, int *packetlen, const PQEnvironmentOption *options)
int be_pid
Definition: libpq-int.h:547
struct addrinfo * addr_cur
Definition: libpq-int.h:431
PGEvent * events
Definition: libpq-int.h:386
ssize_t pqsecure_write(PGconn *, const void *ptr, size_t len)
Definition: fe-secure.c:289
void pqSaveErrorResult(PGconn *conn)
Definition: fe-exec.c:747
bool singleRowMode
Definition: libpq-int.h:400
bool resultInitialized
Definition: libpq-int.h:164
int rowBufLen
Definition: libpq-int.h:466
Oid fn_lo_write
Definition: libpq-int.h:286
int eventArraySize
Definition: libpq-int.h:388
char * replication
Definition: libpq-int.h:350
char * pgpassfile
Definition: libpq-int.h:353
bool sigpipe_so
Definition: libpq-int.h:421
int pqPutMsgEnd(PGconn *conn)
Definition: fe-misc.c:564
int pqRowProcessor(PGconn *conn, const char **errmsgp)
Definition: fe-exec.c:1093
bool password_needed
Definition: libpq-int.h:420
int(* PGEventProc)(PGEventId evtId, void *evtInfo, void *passThrough)
Definition: libpq-events.h:69
ssize_t pgtls_write(PGconn *conn, const void *ptr, size_t len)
char * pqResultStrdup(PGresult *res, const char *str)
Definition: fe-exec.c:647
PGQueryClass
Definition: libpq-int.h:227
def bytes(source, encoding='ascii', errors='strict')
int outCount
Definition: libpq-int.h:457
PQExpBufferData workBuffer
Definition: libpq-int.h:537
void(* PQnoticeProcessor)(void *arg, const char *message)
Definition: libpq-fe.h:174
Oid fn_lo_create
Definition: libpq-int.h:277
PGAsyncStatusType
Definition: libpq-int.h:216
int tupArrSize
Definition: libpq-int.h:174
char * requirepeer
Definition: libpq-int.h:370
char * host
Definition: libpq-int.h:316
const char * value
Definition: libpq-int.h:297
PGresult_data * next
Definition: libpq-int.h:105
PGQueryClass queryclass
Definition: libpq-int.h:394
#define FLEXIBLE_ARRAY_MEMBER
Definition: c.h:350
char copy_is_binary
Definition: libpq-int.h:401
PGnotify * notifyHead
Definition: libpq-int.h:403
Oid fn_lo_lseek
Definition: libpq-int.h:279
char * dbName
Definition: libpq-int.h:349
struct pgMessageField * next
Definition: libpq-int.h:144
int outMsgEnd
Definition: libpq-int.h:462
ExecStatusType
Definition: libpq-fe.h:83
char * ssl_min_protocol_version
Definition: libpq-int.h:375
int spaceLeft
Definition: libpq-int.h:210
void pqClearAsyncResult(PGconn *conn)
Definition: fe-exec.c:731
void pqsecure_close(PGconn *)
Definition: fe-secure.c:191
char * keepalives
Definition: libpq-int.h:356
void pgtls_init_library(bool do_ssl, int do_crypto)
void pqBuildErrorMessage3(PQExpBuffer msg, const PGresult *res, PGVerbosity verbosity, PGContextVisibility show_context)
Definition: fe-protocol3.c:985
int nEvents
Definition: libpq-int.h:188
unsigned int Oid
Definition: postgres_ext.h:31
PGresult * pqPrepareAsyncResult(PGconn *conn)
Definition: fe-exec.c:786
char * errMsg
Definition: libpq-int.h:196
struct addrinfo * addrlist
Definition: libpq-int.h:430
#define CMDSTATUS_LEN
Definition: libpq-int.h:86
char * write_err_msg
Definition: libpq-int.h:424
char * keepalives_idle
Definition: libpq-int.h:357
int pqGets_append(PQExpBuffer buf, PGconn *conn)
Definition: fe-misc.c:155
pg_conn_host_type type
Definition: libpq-int.h:315
PGresAttDesc * attDescs
Definition: libpq-int.h:171
FILE * Pfdebug
Definition: libpq-int.h:380
void pqParseInput3(PGconn *conn)
Definition: fe-protocol3.c:63
void * pqResultAlloc(PGresult *res, size_t nBytes, bool isBinary)
Definition: fe-exec.c:535
PGresult * result
Definition: libpq-int.h:469
#define pg_attribute_printf(f, a)
Definition: c.h:164
void pqInternalNotice(const PGNoticeHooks *hooks, const char *fmt,...) pg_attribute_printf(2
PGresAttValue ** tuples
Definition: libpq-int.h:172
PGresult * pqFunctionCall3(PGconn *conn, Oid fnid, int *result_buf, int *actual_result_len, int result_is_int, const PQArgBlock *args, int nargs)
char * client_encoding_initial
Definition: libpq-int.h:345
static struct @141 value
ssize_t pqsecure_read(PGconn *, void *ptr, size_t len)
Definition: fe-secure.c:207
int sversion
Definition: libpq-int.h:418
char * sslkey
Definition: libpq-int.h:364
PGresult * next_result
Definition: libpq-int.h:470
char * sslcompression
Definition: libpq-int.h:363
PGAsyncStatusType asyncStatus
Definition: libpq-int.h:392
int pqPutnchar(const char *s, size_t len, PGconn *conn)
Definition: fe-misc.c:232
PGTernaryBool default_transaction_read_only
Definition: libpq-int.h:441
int pqCheckInBufferSpace(size_t bytes_needed, PGconn *conn)
Definition: fe-misc.c:394
void pqSaveParameterStatus(PGconn *conn, const char *name, const char *value)
Definition: fe-exec.c:964
bool write_failed
Definition: libpq-int.h:423
void(* pgthreadlock_t)(int acquire)
Definition: libpq-fe.h:383
PGNoticeHooks noticeHooks
Definition: libpq-int.h:186
void * data
Definition: libpq-int.h:163
int pqsecure_initialize(PGconn *)
Definition: fe-secure.c:162
PGconn * conn
Definition: streamutil.c:54
Oid fn_lo_read
Definition: libpq-int.h:285
int inBufSize
Definition: libpq-int.h:449
ssize_t pg_GSS_write(PGconn *conn, const void *ptr, size_t len)
Oid fn_lo_truncate
Definition: libpq-int.h:283
struct pgParameterStatus pgParameterStatus
PostgresPollingStatusType pgtls_open_client(PGconn *conn)
PGNoticeHooks noticeHooks
Definition: libpq-int.h:383
bool try_next_host
Definition: libpq-int.h:429
int curOffset
Definition: libpq-int.h:209
char * hostaddr
Definition: libpq-int.h:317
char * connect_timeout
Definition: libpq-int.h:343
pg_conn_host * connhost
Definition: libpq-int.h:409
void * noticeProcArg
Definition: libpq-int.h:155
bool ssl_in_use
Definition: libpq-int.h:476
void * sasl_state
Definition: libpq-int.h:473
char * keepalives_interval
Definition: libpq-int.h:358
#define libpq_ngettext(s, p, n)
Definition: libpq-int.h:798
char * c
PGVerbosity verbosity
Definition: libpq-int.h:443
PGTernaryBool
Definition: libpq-int.h:248
static char * buf
Definition: pg_test_fsync.c:68
Oid fn_lo_open
Definition: libpq-int.h:274
PQnoticeReceiver noticeRec
Definition: libpq-int.h:152
int pqGetInt(int *result, size_t bytes, PGconn *conn)
Definition: fe-misc.c:253
char * appname
Definition: libpq-int.h:347
PGresult_data * curBlock
Definition: libpq-int.h:208
char * sslpassword
Definition: libpq-int.h:366
char * krbsrvname
Definition: libpq-int.h:372
char * channel_binding
Definition: libpq-int.h:354
int numParameters
Definition: libpq-int.h:175
unsigned int uint32
Definition: c.h:441
int pgsocket
Definition: port.h:31
int pqGetlineAsync3(PGconn *conn, char *buffer, int bufsize)
char * target_session_attrs
Definition: libpq-int.h:377
char * last_query
Definition: libpq-int.h:395
Oid fn_lo_tell64
Definition: libpq-int.h:282
pgthreadlock_t pg_g_threadlock
Definition: fe-connect.c:447
PGdataValue * rowBuf
Definition: libpq-int.h:465
void void pqSaveMessageField(PGresult *res, char code, const char *value)
Definition: fe-exec.c:943
int binary
Definition: libpq-int.h:179
char * pguser
Definition: libpq-int.h:351
const char * pgName
Definition: libpq-int.h:258
#define pg_attribute_format_arg(a)
Definition: c.h:163
PGTargetServerType
Definition: libpq-int.h:236
Oid fn_lo_truncate64
Definition: libpq-int.h:284
int pqReadReady(PGconn *conn)
Definition: fe-misc.c:1063
pgsocket sock
Definition: libpq-int.h:413
int be_key
Definition: libpq-int.h:548
char * gsslib
Definition: libpq-int.h:373
char * errQuery
Definition: libpq-int.h:198
void pqDropConnection(PGconn *conn, bool flushInput)
Definition: fe-connect.c:463
int numAttributes
Definition: libpq-int.h:170
uint32 ProtocolVersion
Definition: pqcomm.h:125
struct PQEnvironmentOption PQEnvironmentOption
struct pgresParamDesc PGresParamDesc
int pqGets(PQExpBuffer buf, PGconn *conn)
Definition: fe-misc.c:149
pg_conn_host_type
Definition: libpq-int.h:301
PGTernaryBool in_hot_standby
Definition: libpq-int.h:442
SockAddr raddr
Definition: libpq-int.h:416
ssize_t pqsecure_raw_read(PGconn *, void *ptr, size_t len)
Definition: fe-secure.c:233
pgParameterStatus * pstatus
Definition: libpq-int.h:438
PGContextVisibility
Definition: libpq-fe.h:119
char * inBuffer
Definition: libpq-int.h:448
int addrlist_family
Definition: libpq-int.h:432
int pqGetCopyData3(PGconn *conn, char **buffer, int async)
int pqPuts(const char *s, PGconn *conn)
Definition: fe-misc.c:165
char *const pgresStatus[]
Definition: fe-exec.c:32
int pgtls_verify_peer_name_matches_certificate_guts(PGconn *conn, int *names_examined, char **first_name)
char * sslmode
Definition: libpq-int.h:362
struct pgresAttValue PGresAttValue
int pqWriteReady(PGconn *conn)
Definition: fe-misc.c:1073
PGVerbosity
Definition: libpq-fe.h:111
PQnoticeProcessor noticeProc
Definition: libpq-int.h:154
int outMsgStart
Definition: libpq-int.h:460
PQExpBufferData errorMessage
Definition: libpq-int.h:534
bool std_strings
Definition: libpq-int.h:440
bool try_next_addr
Definition: libpq-int.h:428
Oid fn_lo_tell
Definition: libpq-int.h:281
int pqGetnchar(char *s, size_t len, PGconn *conn)
Definition: fe-misc.c:181
char * sslcert
Definition: libpq-int.h:365
int pqWaitTimed(int forRead, int forWrite, PGconn *conn, time_t finish_time)
Definition: fe-misc.c:1039
bool options_valid
Definition: libpq-int.h:397
PGTransactionStatusType
Definition: libpq-fe.h:102
int outBufSize
Definition: libpq-int.h:456
PGresParamDesc * paramDescs
Definition: libpq-int.h:176
struct pg_conn_host pg_conn_host
int ntups
Definition: libpq-int.h:169
char * pgoptions
Definition: libpq-int.h:346
char * connip
Definition: libpq-int.h:410
int pqPutc(char c, PGconn *conn)
Definition: fe-misc.c:98
ssize_t pqsecure_raw_write(PGconn *, const void *ptr, size_t len)
Definition: fe-secure.c:315
struct pgParameterStatus * next
Definition: libpq-int.h:265
int pqCheckOutBufferSpace(size_t bytes_needed, PGconn *conn)
Definition: fe-misc.c:330
char contents[FLEXIBLE_ARRAY_MEMBER]
Definition: libpq-int.h:146
char * pgpass
Definition: libpq-int.h:352
ProtocolVersion pversion
Definition: libpq-int.h:417
char * sslrootcert
Definition: libpq-int.h:367
PGEventProc proc
Definition: libpq-int.h:160
ConnStatusType status
Definition: libpq-int.h:391
bool auth_req_received
Definition: libpq-int.h:419
int be_key
Definition: libpq-int.h:437
Oid fn_lo_creat
Definition: libpq-int.h:276
PGnotify * notifyTail
Definition: libpq-int.h:404
int copy_already_done
Definition: libpq-int.h:402
Oid fn_lo_close
Definition: libpq-int.h:275
const char * name
Definition: encode.c:515
int pqFlush(PGconn *conn)
Definition: fe-misc.c:1003
SockAddr laddr
Definition: libpq-int.h:415
char * outBuffer
Definition: libpq-int.h:455
bool nonblocking
Definition: libpq-int.h:398
PostgresPollingStatusType
Definition: libpq-fe.h:73
PostgresPollingStatusType pqsecure_open_client(PGconn *)
Definition: fe-secure.c:177
char * pghostaddr
Definition: libpq-int.h:335
ssize_t pg_GSS_read(PGconn *conn, void *ptr, size_t len)
int PQsendQueryContinue(PGconn *conn, const char *query)
Definition: fe-exec.c:1204
Oid fn_lo_lseek64
Definition: libpq-int.h:280
struct pgLobjfuncs PGlobjfuncs
char * ssl_max_protocol_version
Definition: libpq-int.h:376
int nEvents
Definition: libpq-int.h:387
char * sslcrldir
Definition: libpq-int.h:369
int pqGetc(char *result, PGconn *conn)
Definition: fe-misc.c:80
void * passThrough
Definition: libpq-int.h:162
char * fbappname
Definition: libpq-int.h:348
int client_encoding
Definition: libpq-int.h:439
Oid fn_lo_unlink
Definition: libpq-int.h:278
char * value
Definition: libpq-int.h:138
PostgresPollingStatusType pqsecure_open_gss(PGconn *conn)
SockAddr raddr
Definition: libpq-int.h:546
bool pqGetHomeDirectory(char *buf, int bufsize)
Definition: fe-connect.c:7207
PGEvent * events
Definition: libpq-int.h:187
int inCursor
Definition: libpq-int.h:451
int pqSkipnchar(size_t len, PGconn *conn)
Definition: fe-misc.c:210
char * port
Definition: libpq-int.h:318
char * pgport
Definition: libpq-int.h:339
int pqEndcopy3(PGconn *conn)
int pqGetErrorNotice3(PGconn *conn, bool isError)
Definition: fe-protocol3.c:871
int be_pid
Definition: libpq-int.h:436
PGTargetServerType target_server_type
Definition: libpq-int.h:427
int nconnhost
Definition: libpq-int.h:407
char * name
Definition: libpq-int.h:161
ExecStatusType resultStatus
Definition: libpq-int.h:177
PGlobjfuncs * lobjfuncs
Definition: libpq-int.h:445
char * pgtcp_user_timeout
Definition: libpq-int.h:344
int pgtls_init(PGconn *conn)
char * sslcrl
Definition: libpq-int.h:368
void pqSetResultError(PGresult *res, const char *msg)
Definition: fe-exec.c:661
int whichhost
Definition: libpq-int.h:408
struct pgMessageField PGMessageField
#define libpq_gettext(x)
Definition: libpq-int.h:797
int pqGetline3(PGconn *conn, char *s, int maxlen)
bool send_appname
Definition: libpq-int.h:433
PGTransactionStatusType xactStatus
Definition: libpq-int.h:393
char * keepalives_count
Definition: libpq-int.h:360
char * pghost
Definition: libpq-int.h:331
char * pgtty
Definition: libpq-int.h:341
void * noticeRecArg
Definition: libpq-int.h:153
int client_encoding
Definition: libpq-int.h:189
char * password
Definition: libpq-int.h:319