protocol.go 6.8 KB

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