2
0

protocol.go 7.0 KB

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