protocol.go 7.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273
  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. ErrCodeCheckViolation = "23514"
  93. )
  94. // Message represents a PostgreSQL protocol message
  95. type Message struct {
  96. Type byte
  97. Data []byte
  98. }
  99. // WriteMessage writes a message to the writer
  100. func WriteMessage(w io.Writer, msgType byte, data []byte) error {
  101. // Write message type
  102. if _, err := w.Write([]byte{msgType}); err != nil {
  103. return err
  104. }
  105. // Write message length (includes itself, 4 bytes)
  106. length := uint32(len(data) + 4)
  107. if err := binary.Write(w, binary.BigEndian, length); err != nil {
  108. return err
  109. }
  110. // Write message data
  111. if _, err := w.Write(data); err != nil {
  112. return err
  113. }
  114. return nil
  115. }
  116. // ReadMessage reads a message from the reader
  117. func ReadMessage(r io.Reader) (*Message, error) {
  118. // Read message type
  119. typeBuf := make([]byte, 1)
  120. if _, err := io.ReadFull(r, typeBuf); err != nil {
  121. return nil, err
  122. }
  123. // Read message length
  124. var length uint32
  125. if err := binary.Read(r, binary.BigEndian, &length); err != nil {
  126. return nil, err
  127. }
  128. if length < 4 {
  129. return nil, fmt.Errorf("invalid message length: %d", length)
  130. }
  131. if length > MaxMessageSize {
  132. return nil, fmt.Errorf("message length %d exceeds maximum %d", length, MaxMessageSize)
  133. }
  134. // Read message data
  135. data := make([]byte, length-4)
  136. if _, err := io.ReadFull(r, data); err != nil {
  137. return nil, err
  138. }
  139. return &Message{
  140. Type: typeBuf[0],
  141. Data: data,
  142. }, nil
  143. }
  144. // ReadStartupMessage reads the initial startup message (no type byte)
  145. func ReadStartupMessage(r io.Reader) (map[string]string, error) {
  146. // Read message length
  147. var length uint32
  148. if err := binary.Read(r, binary.BigEndian, &length); err != nil {
  149. return nil, err
  150. }
  151. if length < 8 {
  152. return nil, fmt.Errorf("invalid startup message length: %d", length)
  153. }
  154. if length > MaxStartupMessageSize {
  155. return nil, fmt.Errorf("startup message length %d exceeds maximum %d", length, MaxStartupMessageSize)
  156. }
  157. // Read protocol version
  158. var version uint32
  159. if err := binary.Read(r, binary.BigEndian, &version); err != nil {
  160. return nil, err
  161. }
  162. // Read parameters
  163. data := make([]byte, length-8)
  164. if _, err := io.ReadFull(r, data); err != nil {
  165. return nil, err
  166. }
  167. params := make(map[string]string)
  168. params["protocol_version"] = fmt.Sprintf("%d", version)
  169. // Parse null-terminated key-value pairs
  170. i := 0
  171. for i < len(data) {
  172. if data[i] == 0 {
  173. break
  174. }
  175. // Read key
  176. keyStart := i
  177. for i < len(data) && data[i] != 0 {
  178. i++
  179. }
  180. if i >= len(data) {
  181. break
  182. }
  183. key := string(data[keyStart:i])
  184. i++ // skip null
  185. // Read value
  186. valueStart := i
  187. for i < len(data) && data[i] != 0 {
  188. i++
  189. }
  190. if i > len(data) {
  191. break
  192. }
  193. value := string(data[valueStart:i])
  194. i++ // skip null
  195. params[key] = value
  196. }
  197. return params, nil
  198. }
  199. // MessageBuilder helps build protocol messages
  200. type MessageBuilder struct {
  201. data []byte
  202. }
  203. // NewMessageBuilder creates a new message builder
  204. func NewMessageBuilder() *MessageBuilder {
  205. return &MessageBuilder{
  206. data: make([]byte, 0, 1024),
  207. }
  208. }
  209. // AppendByte appends a single byte.
  210. func (mb *MessageBuilder) AppendByte(b byte) {
  211. mb.data = append(mb.data, b)
  212. }
  213. // WriteInt16 writes a 16-bit integer
  214. func (mb *MessageBuilder) WriteInt16(n int16) {
  215. mb.data = append(mb.data, byte(n>>8), byte(n))
  216. }
  217. // WriteInt32 writes a 32-bit integer
  218. func (mb *MessageBuilder) WriteInt32(n int32) {
  219. mb.data = append(mb.data, byte(n>>24), byte(n>>16), byte(n>>8), byte(n))
  220. }
  221. // WriteString writes a null-terminated string
  222. func (mb *MessageBuilder) WriteString(s string) {
  223. mb.data = append(mb.data, []byte(s)...)
  224. mb.data = append(mb.data, 0)
  225. }
  226. // WriteBytes writes raw bytes
  227. func (mb *MessageBuilder) WriteBytes(b []byte) {
  228. mb.data = append(mb.data, b...)
  229. }
  230. // Bytes returns the built message data
  231. func (mb *MessageBuilder) Bytes() []byte {
  232. return mb.data
  233. }
  234. // Reset resets the builder for reuse
  235. func (mb *MessageBuilder) Reset() {
  236. mb.data = mb.data[:0]
  237. }