pg 7.7.1 → 7.9.0

package/CHANGELOG.md

@@ -4,6 +4,15 @@ For richer information consult the commit log on github with referenced pull req
 
 We do not include break-fix version release in this file.
 
+### 7.9.0
+
+- Add support for [sasl/scram authentication](https://github.com/brianc/node-postgres/pull/1835).
+
+### 7.8.0
+
+- Add support for passing [secureOptions](https://github.com/brianc/node-postgres/pull/1804) SSL config.
+- Upgrade [pg-types](https://github.com/brianc/node-postgres/pull/1806) to 2.0.
+
 ### 7.7.0
 
 - Add support for configurable [query timeout](https://github.com/brianc/node-postgres/pull/1760) on a client level.

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2010 - 2018 Brian Carlson
+Copyright (c) 2010 - 2019 Brian Carlson
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -67,7 +67,7 @@ The causes and solutions to common errors can be found among the [Frequently Ask
 
 ## License
 
-Copyright (c) 2010-2018 Brian Carlson (brian.m.carlson@gmail.com)
+Copyright (c) 2010-2019 Brian Carlson (brian.m.carlson@gmail.com)
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal

package/SPONSORS.md

@@ -2,6 +2,7 @@ node-postgres is made possible by the helpful contributors from the community we
 
 # Leaders
 - [MadKudu](https://www.madkudu.com) - [@madkudu](https://twitter.com/madkudu)
+- [Third Iron](https://thirdiron.com/)
 
 # Supporters
 - John Fawcett
@@ -17,3 +18,5 @@ node-postgres is made possible by the helpful contributors from the community we
 - Benjie Gillam
 - David Hanson
 - Franklin Davenport
+- [Eventbot](https://geteventbot.com/)
+- Chuck T

package/lib/client.js

@@ -10,6 +10,7 @@
 var EventEmitter = require('events').EventEmitter
 var util = require('util')
 var utils = require('./utils')
+var sasl = require('./sasl')
 var pgPass = require('pgpass')
 var TypeOverrides = require('./type-overrides')
 
@@ -126,6 +127,28 @@ Client.prototype._connect = function (callback) {
     con.password(utils.postgresMd5PasswordHash(self.user, self.password, msg.salt))
   }))
 
+  // password request handling (SASL)
+  var saslSession
+  con.on('authenticationSASL', checkPgPass(function (msg) {
+    saslSession = sasl.startSession(msg.mechanisms)
+
+    con.sendSASLInitialResponseMessage(saslSession.mechanism, saslSession.response)
+  }))
+
+  // password request handling (SASL)
+  con.on('authenticationSASLContinue', function (msg) {
+    sasl.continueSession(saslSession, self.password, msg.data)
+
+    con.sendSCRAMClientFinalMessage(saslSession.response)
+  })
+
+  // password request handling (SASL)
+  con.on('authenticationSASLFinal', function (msg) {
+    sasl.finalizeSession(saslSession, msg.data)
+
+    saslSession = null
+  })
+
   con.once('backendKeyData', function (msg) {
     self.processID = msg.processID
     self.secretKey = msg.secretKey
@@ -276,7 +299,7 @@ Client.prototype._attachListeners = function (con) {
   // it again on the same client
   con.on('parseComplete', function (msg) {
     if (self.activeQuery.name) {
-      con.parsedStatements[self.activeQuery.name] = true
+      con.parsedStatements[self.activeQuery.name] = self.activeQuery.text
     }
   })
 

package/lib/connection.js

@@ -101,6 +101,7 @@ Connection.prototype.connect = function (port, host) {
       key: self.ssl.key,
       passphrase: self.ssl.passphrase,
       cert: self.ssl.cert,
+      secureOptions: self.ssl.secureOptions,
       NPNProtocols: self.ssl.NPNProtocols
     })
     self.attachListeners(self.stream)
@@ -190,6 +191,24 @@ Connection.prototype.password = function (password) {
   this._send(0x70, this.writer.addCString(password))
 }
 
+Connection.prototype.sendSASLInitialResponseMessage = function (mechanism, initialResponse) {
+  // 0x70 = 'p'
+  this.writer
+    .addCString(mechanism)
+    .addInt32(Buffer.byteLength(initialResponse))
+    .addString(initialResponse)
+
+  this._send(0x70)
+}
+
+Connection.prototype.sendSCRAMClientFinalMessage = function (additionalData) {
+  // 0x70 = 'p'
+  this.writer
+    .addString(additionalData)
+
+  this._send(0x70)
+}
+
 Connection.prototype._send = function (code, more) {
   if (!this.stream.writable) {
     return false
@@ -420,25 +439,53 @@ Connection.prototype.parseMessage = function (buffer) {
 }
 
 Connection.prototype.parseR = function (buffer, length) {
-  var code = 0
+  var code = this.parseInt32(buffer)
+
   var msg = new Message('authenticationOk', length)
-  if (msg.length === 8) {
-    code = this.parseInt32(buffer)
-    if (code === 3) {
-      msg.name = 'authenticationCleartextPassword'
-    }
-    return msg
-  }
-  if (msg.length === 12) {
-    code = this.parseInt32(buffer)
-    if (code === 5) { // md5 required
-      msg.name = 'authenticationMD5Password'
-      msg.salt = Buffer.alloc(4)
-      buffer.copy(msg.salt, 0, this.offset, this.offset + 4)
-      this.offset += 4
+
+  switch (code) {
+    case 0: // AuthenticationOk
+      return msg
+    case 3: // AuthenticationCleartextPassword
+      if (msg.length === 8) {
+        msg.name = 'authenticationCleartextPassword'
+        return msg
+      }
+      break
+    case 5: // AuthenticationMD5Password
+      if (msg.length === 12) {
+        msg.name = 'authenticationMD5Password'
+        msg.salt = Buffer.alloc(4)
+        buffer.copy(msg.salt, 0, this.offset, this.offset + 4)
+        this.offset += 4
+        return msg
+      }
+
+      break
+    case 10: // AuthenticationSASL
+      msg.name = 'authenticationSASL'
+      msg.mechanisms = []
+      do {
+        var mechanism = this.parseCString(buffer)
+
+        if (mechanism) {
+          msg.mechanisms.push(mechanism)
+        }
+      } while (mechanism)
+
+      return msg
+    case 11: // AuthenticationSASLContinue
+      msg.name = 'authenticationSASLContinue'
+      msg.data = this.readString(buffer, length - 4)
+
+      return msg
+    case 12: // AuthenticationSASLFinal
+      msg.name = 'authenticationSASLFinal'
+      msg.data = this.readString(buffer, length - 4)
+
       return msg
-    }
   }
+
   throw new Error('Unknown authenticationOk message type' + util.inspect(msg))
 }
 

package/lib/native/query.js

@@ -139,12 +139,16 @@ NativeQuery.prototype.submit = function (client) {
     // check if the client has already executed this named query
     // if so...just execute it again - skip the planning phase
     if (client.namedQueries[this.name]) {
+      if (this.text && client.namedQueries[this.name] !== this.text) {
+        const err = new Error(`Prepared statements must be unique - '${this.name}' was used for a different statement`)
+        return after(err)
+      }
       return client.native.execute(this.name, values, after)
     }
     // plan the named query the first time, then execute it
     return client.native.prepare(this.name, this.text, values.length, function (err) {
       if (err) return after(err)
-      client.namedQueries[self.name] = true
+      client.namedQueries[self.name] = self.text
       return self.native.execute(self.name, values, after)
     })
   } else if (this.values) {

package/lib/query.js

@@ -148,6 +148,10 @@ Query.prototype.submit = function (connection) {
   if (typeof this.text !== 'string' && typeof this.name !== 'string') {
     return new Error('A query must have either text or a name. Supplying neither is unsupported.')
   }
+  const previous = connection.parsedStatements[this.name]
+  if (this.text && previous && this.text !== previous) {
+    return new Error(`Prepared statements must be unique - '${this.name}' was used for a different statement`)
+  }
   if (this.values && !Array.isArray(this.values)) {
     return new Error('Query values must be an array')
   }

package/lib/sasl.js

@@ -0,0 +1,146 @@
+const crypto = require('crypto')
+
+function startSession (mechanisms) {
+  if (mechanisms.indexOf('SCRAM-SHA-256') === -1) {
+    throw new Error('SASL: Only mechanism SCRAM-SHA-256 is currently supported')
+  }
+
+  const clientNonce = crypto.randomBytes(18).toString('base64')
+
+  return {
+    mechanism: 'SCRAM-SHA-256',
+    clientNonce,
+    response: 'n,,n=*,r=' + clientNonce,
+    message: 'SASLInitialResponse'
+  }
+}
+
+function continueSession (session, password, serverData) {
+  if (session.message !== 'SASLInitialResponse') {
+    throw new Error('SASL: Last message was not SASLInitialResponse')
+  }
+
+  const sv = extractVariablesFromFirstServerMessage(serverData)
+
+  if (!sv.nonce.startsWith(session.clientNonce)) {
+    throw new Error('SASL: SCRAM-SERVER-FIRST-MESSAGE: server nonce does not start with client nonce')
+  }
+
+  var saltBytes = Buffer.from(sv.salt, 'base64')
+
+  var saltedPassword = Hi(password, saltBytes, sv.iteration)
+
+  var clientKey = createHMAC(saltedPassword, 'Client Key')
+  var storedKey = crypto.createHash('sha256').update(clientKey).digest()
+
+  var clientFirstMessageBare = 'n=*,r=' + session.clientNonce
+  var serverFirstMessage = 'r=' + sv.nonce + ',s=' + sv.salt + ',i=' + sv.iteration
+
+  var clientFinalMessageWithoutProof = 'c=biws,r=' + sv.nonce
+
+  var authMessage = clientFirstMessageBare + ',' + serverFirstMessage + ',' + clientFinalMessageWithoutProof
+
+  var clientSignature = createHMAC(storedKey, authMessage)
+  var clientProofBytes = xorBuffers(clientKey, clientSignature)
+  var clientProof = clientProofBytes.toString('base64')
+
+  var serverKey = createHMAC(saltedPassword, 'Server Key')
+  var serverSignatureBytes = createHMAC(serverKey, authMessage)
+
+  session.message = 'SASLResponse'
+  session.serverSignature = serverSignatureBytes.toString('base64')
+  session.response = clientFinalMessageWithoutProof + ',p=' + clientProof
+}
+
+function finalizeSession (session, serverData) {
+  if (session.message !== 'SASLResponse') {
+    throw new Error('SASL: Last message was not SASLResponse')
+  }
+
+  var serverSignature
+
+  String(serverData).split(',').forEach(function (part) {
+    switch (part[0]) {
+      case 'v':
+        serverSignature = part.substr(2)
+        break
+    }
+  })
+
+  if (serverSignature !== session.serverSignature) {
+    throw new Error('SASL: SCRAM-SERVER-FINAL-MESSAGE: server signature does not match')
+  }
+}
+
+function extractVariablesFromFirstServerMessage (data) {
+  var nonce, salt, iteration
+
+  String(data).split(',').forEach(function (part) {
+    switch (part[0]) {
+      case 'r':
+        nonce = part.substr(2)
+        break
+      case 's':
+        salt = part.substr(2)
+        break
+      case 'i':
+        iteration = parseInt(part.substr(2), 10)
+        break
+    }
+  })
+
+  if (!nonce) {
+    throw new Error('SASL: SCRAM-SERVER-FIRST-MESSAGE: nonce missing')
+  }
+
+  if (!salt) {
+    throw new Error('SASL: SCRAM-SERVER-FIRST-MESSAGE: salt missing')
+  }
+
+  if (!iteration) {
+    throw new Error('SASL: SCRAM-SERVER-FIRST-MESSAGE: iteration missing')
+  }
+
+  return {
+    nonce,
+    salt,
+    iteration
+  }
+}
+
+function xorBuffers (a, b) {
+  if (!Buffer.isBuffer(a)) a = Buffer.from(a)
+  if (!Buffer.isBuffer(b)) b = Buffer.from(b)
+  var res = []
+  if (a.length > b.length) {
+    for (var i = 0; i < b.length; i++) {
+      res.push(a[i] ^ b[i])
+    }
+  } else {
+    for (var j = 0; j < a.length; j++) {
+      res.push(a[j] ^ b[j])
+    }
+  }
+  return Buffer.from(res)
+}
+
+function createHMAC (key, msg) {
+  return crypto.createHmac('sha256', key).update(msg).digest()
+}
+
+function Hi (password, saltBytes, iterations) {
+  var ui1 = createHMAC(password, Buffer.concat([saltBytes, Buffer.from([0, 0, 0, 1])]))
+  var ui = ui1
+  for (var i = 0; i < iterations - 1; i++) {
+    ui1 = createHMAC(password, ui1)
+    ui = xorBuffers(ui, ui1)
+  }
+
+  return ui
+}
+
+module.exports = {
+  startSession,
+  continueSession,
+  finalizeSession
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pg",
-  "version": "7.7.1",
+  "version": "7.9.0",
   "description": "PostgreSQL client - pure javascript & libpq with the same API",
   "keywords": [
     "database",
@@ -20,10 +20,10 @@
   "main": "./lib",
   "dependencies": {
     "buffer-writer": "2.0.0",
-    "packet-reader": "0.3.1",
+    "packet-reader": "1.0.0",
     "pg-connection-string": "0.1.3",
     "pg-pool": "^2.0.4",
-    "pg-types": "~1.12.1",
+    "pg-types": "~2.0.0",
     "pgpass": "1.x",
     "semver": "4.3.2"
   },

package/.travis.yml

@@ -1,41 +0,0 @@
-language: node_js
-sudo: false
-dist: trusty
-before_script:
-  - node script/create-test-tables.js pg://postgres@127.0.0.1:5432/postgres
-env:
-  - CC=clang CXX=clang++ npm_config_clang=1 PGUSER=postgres PGDATABASE=postgres
-
-matrix:
-  include:
-    - node_js: "lts/boron"
-      addons:
-        postgresql: "9.6"
-    - node_js: "lts/argon"
-      addons:
-        postgresql: "9.6"
-    - node_js: "10"
-      addons:
-        postgresql: "9.6"
-    - node_js: "11"
-      addons:
-        postgresql: "9.6"
-    - node_js: "lts/carbon"
-      addons:
-        postgresql: "9.1"
-      dist: precise
-    - node_js: "lts/carbon"
-      addons:
-        postgresql: "9.2"
-    - node_js: "lts/carbon"
-      addons:
-        postgresql: "9.3"
-    - node_js: "lts/carbon"
-      addons:
-        postgresql: "9.4"
-    - node_js: "lts/carbon"
-      addons:
-        postgresql: "9.5"
-    - node_js: "lts/carbon"
-      addons:
-        postgresql: "9.6"