protocol.go 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  1. package pgserver
  2. import (
  3. "encoding/binary"
  4. "fmt"
  5. "io"
  6. )
  7. // Maximum message sizes enforced before any allocation, to bound memory use
  8. // against malformed or hostile clients. Regular protocol messages (queries,
  9. // bind parameters, etc.) are capped at 16 MiB; startup messages are much
  10. // smaller and capped at 1 MiB.
  11. const (
  12. MaxMessageSize = 16 * 1024 * 1024 // 16 MiB
  13. MaxStartupMessageSize = 1 * 1024 * 1024 // 1 MiB
  14. )
  15. // Message type constants (first byte of message)
  16. const (
  17. // Frontend (client) messages
  18. MsgStartup = 0 // Startup message (no type byte)
  19. MsgQuery = 'Q' // Simple query
  20. // MsgProxyError is a negotiated managed-proxy extension. Its one-byte
  21. // payload is Q or P, replacing a denied Query or Parse in stream order.
  22. MsgProxyError = 'y'
  23. MsgTerminate = 'X' // Terminate
  24. MsgPassword = 'p' // Password message
  25. MsgParse = 'P' // Parse (prepared statement)
  26. MsgBind = 'B' // Bind
  27. MsgDescribe = 'D' // Describe
  28. MsgExecute = 'E' // Execute
  29. MsgSync = 'S' // Sync
  30. MsgFlush = 'H' // Flush
  31. MsgClose = 'C' // Close
  32. // Backend (server) messages
  33. MsgAuthenticationOk = 'R' // Authentication request
  34. MsgBackendKeyData = 'K' // Backend key data
  35. MsgBindComplete = '2' // Bind complete
  36. MsgCloseComplete = '3' // Close complete
  37. MsgCommandComplete = 'C' // Command complete
  38. MsgDataRow = 'D' // Data row
  39. MsgEmptyQueryResponse = 'I' // Empty query response
  40. MsgErrorResponse = 'E' // Error response
  41. MsgNoData = 'n' // No data
  42. MsgNoticeResponse = 'N' // Notice response
  43. MsgParameterDescription = 't' // Parameter description
  44. MsgParameterStatus = 'S' // Parameter status
  45. MsgParseComplete = '1' // Parse complete
  46. MsgReadyForQuery = 'Z' // Ready for query
  47. MsgRowDescription = 'T' // Row description
  48. MsgNotificationResponse = 'A' // Notification response
  49. )
  50. // Transaction status
  51. const (
  52. TxStatusIdle = 'I' // Idle (not in transaction)
  53. TxStatusInBlock = 'T' // In transaction block
  54. TxStatusFailed = 'E' // In failed transaction block
  55. )
  56. // Error field types
  57. const (
  58. ErrorFieldSeverity = 'S'
  59. ErrorFieldCode = 'C'
  60. ErrorFieldMessage = 'M'
  61. ErrorFieldDetail = 'D'
  62. ErrorFieldHint = 'H'
  63. ErrorFieldPosition = 'P'
  64. ErrorFieldInternalPosition = 'p'
  65. ErrorFieldInternalQuery = 'q'
  66. ErrorFieldWhere = 'W'
  67. ErrorFieldSchemaName = 's'
  68. ErrorFieldTableName = 't'
  69. ErrorFieldColumnName = 'c'
  70. ErrorFieldDataTypeName = 'd'
  71. ErrorFieldConstraintName = 'n'
  72. ErrorFieldFile = 'F'
  73. ErrorFieldLine = 'L'
  74. ErrorFieldRoutine = 'R'
  75. )
  76. // PostgreSQL error codes (subset)
  77. const (
  78. ErrCodeSuccess = "00000"
  79. ErrCodeSyntaxError = "42601"
  80. ErrCodeUndefinedTable = "42P01"
  81. ErrCodeUndefinedColumn = "42703"
  82. ErrCodeDuplicateTable = "42P07"
  83. ErrCodeDuplicateColumn = "42701"
  84. ErrCodeInvalidParameter = "22023"
  85. ErrCodeInternalError = "XX000"
  86. ErrCodeConnectionFailure = "08006"
  87. ErrCodeProtocolViolation = "08P01"
  88. ErrCodeFeatureNotSupported = "0A000"
  89. ErrCodeTransactionAborted = "25P02"
  90. ErrCodeSerializationFailure = "40001"
  91. ErrCodeUniqueViolation = "23505"
  92. ErrCodeForeignKeyViolation = "23503"
  93. ErrCodeCheckViolation = "23514"
  94. )
  95. // Message represents a PostgreSQL protocol message
  96. type Message struct {
  97. Type byte
  98. Data []byte
  99. }
  100. // WriteMessage writes a message to the writer
  101. func WriteMessage(w io.Writer, msgType byte, data []byte) error {
  102. // Write message type
  103. if _, err := w.Write([]byte{msgType}); err != nil {
  104. return err
  105. }
  106. // Write message length (includes itself, 4 bytes)
  107. length := uint32(len(data) + 4)
  108. if err := binary.Write(w, binary.BigEndian, length); err != nil {
  109. return err
  110. }
  111. // Write message data
  112. if _, err := w.Write(data); err != nil {
  113. return err
  114. }
  115. return nil
  116. }
  117. // ReadMessage reads a message from the reader
  118. func ReadMessage(r io.Reader) (*Message, error) {
  119. // Read message type
  120. typeBuf := make([]byte, 1)
  121. if _, err := io.ReadFull(r, typeBuf); err != nil {
  122. return nil, err
  123. }
  124. // Read message length
  125. var length uint32
  126. if err := binary.Read(r, binary.BigEndian, &length); err != nil {
  127. return nil, err
  128. }
  129. if length < 4 {
  130. return nil, fmt.Errorf("invalid message length: %d", length)
  131. }
  132. if length > MaxMessageSize {
  133. return nil, fmt.Errorf("message length %d exceeds maximum %d", length, MaxMessageSize)
  134. }
  135. // Read message data
  136. data := make([]byte, length-4)
  137. if _, err := io.ReadFull(r, data); err != nil {
  138. return nil, err
  139. }
  140. return &Message{
  141. Type: typeBuf[0],
  142. Data: data,
  143. }, nil
  144. }
  145. // ReadStartupMessage reads the initial startup message (no type byte)
  146. func ReadStartupMessage(r io.Reader) (map[string]string, error) {
  147. // Read message length
  148. var length uint32
  149. if err := binary.Read(r, binary.BigEndian, &length); err != nil {
  150. return nil, err
  151. }
  152. if length < 8 {
  153. return nil, fmt.Errorf("invalid startup message length: %d", length)
  154. }
  155. if length > MaxStartupMessageSize {
  156. return nil, fmt.Errorf("startup message length %d exceeds maximum %d", length, MaxStartupMessageSize)
  157. }
  158. // Read protocol version
  159. var version uint32
  160. if err := binary.Read(r, binary.BigEndian, &version); err != nil {
  161. return nil, err
  162. }
  163. // Read parameters
  164. data := make([]byte, length-8)
  165. if _, err := io.ReadFull(r, data); err != nil {
  166. return nil, err
  167. }
  168. params := make(map[string]string)
  169. params["protocol_version"] = fmt.Sprintf("%d", version)
  170. // Parse null-terminated key-value pairs
  171. i := 0
  172. for i < len(data) {
  173. if data[i] == 0 {
  174. break
  175. }
  176. // Read key
  177. keyStart := i
  178. for i < len(data) && data[i] != 0 {
  179. i++
  180. }
  181. if i >= len(data) {
  182. break
  183. }
  184. key := string(data[keyStart:i])
  185. i++ // skip null
  186. // Read value
  187. valueStart := i
  188. for i < len(data) && data[i] != 0 {
  189. i++
  190. }
  191. if i > len(data) {
  192. break
  193. }
  194. value := string(data[valueStart:i])
  195. i++ // skip null
  196. params[key] = value
  197. }
  198. return params, nil
  199. }
  200. // MessageBuilder helps build protocol messages
  201. type MessageBuilder struct {
  202. data []byte
  203. }
  204. // NewMessageBuilder creates a new message builder
  205. func NewMessageBuilder() *MessageBuilder {
  206. return &MessageBuilder{
  207. data: make([]byte, 0, 1024),
  208. }
  209. }
  210. // AppendByte appends a single byte.
  211. func (mb *MessageBuilder) AppendByte(b byte) {
  212. mb.data = append(mb.data, b)
  213. }
  214. // WriteInt16 writes a 16-bit integer
  215. func (mb *MessageBuilder) WriteInt16(n int16) {
  216. mb.data = append(mb.data, byte(n>>8), byte(n))
  217. }
  218. // WriteInt32 writes a 32-bit integer
  219. func (mb *MessageBuilder) WriteInt32(n int32) {
  220. mb.data = append(mb.data, byte(n>>24), byte(n>>16), byte(n>>8), byte(n))
  221. }
  222. // WriteString writes a null-terminated string
  223. func (mb *MessageBuilder) WriteString(s string) {
  224. mb.data = append(mb.data, []byte(s)...)
  225. mb.data = append(mb.data, 0)
  226. }
  227. // WriteBytes writes raw bytes
  228. func (mb *MessageBuilder) WriteBytes(b []byte) {
  229. mb.data = append(mb.data, b...)
  230. }
  231. // Bytes returns the built message data
  232. func (mb *MessageBuilder) Bytes() []byte {
  233. return mb.data
  234. }
  235. // Reset resets the builder for reuse
  236. func (mb *MessageBuilder) Reset() {
  237. mb.data = mb.data[:0]
  238. }