postgrejs 2.22.9 → 2.23.0

package/cjs/protocol/pg-socket.js

@@ -1,367 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PgSocket = void 0;
-const tslib_1 = require("tslib");
-const node_crypto_1 = tslib_1.__importDefault(require("node:crypto"));
-const node_net_1 = tslib_1.__importDefault(require("node:net"));
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const node_tls_1 = tslib_1.__importDefault(require("node:tls"));
-const putil_promisify_1 = tslib_1.__importDefault(require("putil-promisify"));
-const constants_js_1 = require("../constants.js");
-const safe_event_emitter_js_1 = require("../safe-event-emitter.js");
-const backend_js_1 = require("./backend.js");
-const database_error_js_1 = require("./database-error.js");
-const frontend_js_1 = require("./frontend.js");
-const protocol_js_1 = require("./protocol.js");
-const sasl_js_1 = require("./sasl.js");
-const DEFAULT_PORT_NUMBER = 5432;
-const COMMAND_RESULT_PATTERN = /^([^\d]+)(?: (\d+)(?: (\d+))?)?$/;
-class PgSocket extends safe_event_emitter_js_1.SafeEventEmitter {
-    constructor(options) {
-        super();
-        this.options = options;
-        this._state = constants_js_1.ConnectionState.CLOSED;
-        this._backend = new backend_js_1.Backend();
-        this._sessionParameters = {};
-        this._frontend = new frontend_js_1.Frontend({ buffer: options.buffer });
-        this.setMaxListeners(99);
-    }
-    get state() {
-        if (!this._socket || this._socket.destroyed)
-            this._state = constants_js_1.ConnectionState.CLOSED;
-        return this._state;
-    }
-    get processID() {
-        return this._processID;
-    }
-    get secretKey() {
-        return this._secretKey;
-    }
-    get sessionParameters() {
-        return this._sessionParameters;
-    }
-    connect() {
-        if (this._socket)
-            return;
-        this._state = constants_js_1.ConnectionState.CONNECTING;
-        const options = this.options;
-        const socket = (this._socket = new node_net_1.default.Socket());
-        const errorHandler = (err) => {
-            this._state = constants_js_1.ConnectionState.CLOSED;
-            this._removeListeners();
-            this._reset();
-            socket.destroy();
-            this._socket = undefined;
-            this.emit('error', err);
-        };
-        const connectHandler = () => {
-            socket.setTimeout(0);
-            if (this.options.keepAlive || this.options.keepAlive == null)
-                socket.setKeepAlive(true);
-            socket.write(this._frontend.getSSLRequestMessage());
-            socket.once('data', x => {
-                this._removeListeners();
-                if (x.toString() === 'S') {
-                    const tslOptions = { ...options.ssl, socket };
-                    if (options.host && node_net_1.default.isIP(options.host) === 0)
-                        tslOptions.servername = options.host;
-                    const tlsSocket = (this._socket = node_tls_1.default.connect(tslOptions));
-                    tlsSocket.once('error', errorHandler);
-                    tlsSocket.once('secureConnect', () => {
-                        this._removeListeners();
-                        this._handleConnect();
-                    });
-                    return;
-                }
-                if (x.toString() === 'N') {
-                    if (options.requireSSL) {
-                        return errorHandler(new Error('Server does not support SSL connections'));
-                    }
-                    this._removeListeners();
-                    this._handleConnect();
-                    return;
-                }
-                return errorHandler(new Error('There was an error establishing an SSL connection'));
-            });
-        };
-        socket.setNoDelay(true);
-        socket.setTimeout(options.connectTimeoutMs || 30000, () => errorHandler(new Error('Connection timed out')));
-        socket.once('error', errorHandler);
-        socket.once('connect', connectHandler);
-        this.emit('connecting');
-        const port = options.port || DEFAULT_PORT_NUMBER;
-        if (options.host && options.host.startsWith('/')) {
-            socket.connect(node_path_1.default.join(options.host, '/.s.PGSQL.' + port));
-        }
-        else
-            socket.connect(options.port || DEFAULT_PORT_NUMBER, options.host || 'localhost');
-    }
-    close() {
-        if (!this._socket || this._socket.destroyed) {
-            this._state = constants_js_1.ConnectionState.CLOSED;
-            this._socket = undefined;
-            this._reset();
-            return;
-        }
-        if (this._state === constants_js_1.ConnectionState.CLOSING)
-            return;
-        const socket = this._socket;
-        this._state = constants_js_1.ConnectionState.CLOSING;
-        this._removeListeners();
-        socket.once('close', () => this._handleClose());
-        socket.destroy();
-    }
-    sendParseMessage(args, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendParseMessage', args });
-        this._send(this._frontend.getParseMessage(args), cb);
-    }
-    sendBindMessage(args, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendBindMessage', args });
-        this._send(this._frontend.getBindMessage(args), cb);
-    }
-    sendDescribeMessage(args, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendDescribeMessage', args });
-        this._send(this._frontend.getDescribeMessage(args), cb);
-    }
-    sendExecuteMessage(args, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendDescribeMessage', args });
-        this._send(this._frontend.getExecuteMessage(args), cb);
-    }
-    sendCloseMessage(args, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendCloseMessage', args });
-        this._send(this._frontend.getCloseMessage(args), cb);
-    }
-    sendQueryMessage(sql, cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendQueryMessage', sql });
-        this._send(this._frontend.getQueryMessage(sql), cb);
-    }
-    sendFlushMessage(cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendFlushMessage' });
-        this._send(this._frontend.getFlushMessage(), cb);
-    }
-    sendTerminateMessage(cb) {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendTerminateMessage' });
-        this._send(this._frontend.getTerminateMessage(), cb);
-    }
-    sendSyncMessage() {
-        if (this.listenerCount('debug'))
-            this.emit('debug', { location: 'PgSocket.sendSyncMessage' });
-        this._send(this._frontend.getSyncMessage());
-    }
-    capture(callback) {
-        if (this._state === constants_js_1.ConnectionState.CLOSING ||
-            this._state === constants_js_1.ConnectionState.CLOSED) {
-            return Promise.reject(new Error('Connection closed'));
-        }
-        if (this._state !== constants_js_1.ConnectionState.READY)
-            return Promise.reject(new Error('Connection is not ready'));
-        return new Promise((resolve, reject) => {
-            const done = (err, result) => {
-                this.removeListener('close', closeHandler);
-                this.removeListener('error', errorHandler);
-                this.removeListener('message', msgHandler);
-                if (err)
-                    reject(err);
-                else
-                    resolve(result);
-            };
-            const errorHandler = (err) => {
-                this.removeListener('close', closeHandler);
-                this.removeListener('message', msgHandler);
-                reject(err);
-            };
-            const closeHandler = () => {
-                this.removeListener('error', errorHandler);
-                this.removeListener('message', msgHandler);
-                reject(new Error('Connection closed'));
-            };
-            const msgHandler = (code, msg) => {
-                const x = callback(code, msg, done);
-                if (putil_promisify_1.default.isPromise(x))
-                    x.catch(err => done(err));
-            };
-            this.once('close', closeHandler);
-            this.once('error', errorHandler);
-            this.on('message', msgHandler);
-        });
-    }
-    _removeListeners() {
-        if (!this._socket)
-            return;
-        this._socket.removeAllListeners('error');
-        this._socket.removeAllListeners('connect');
-        this._socket.removeAllListeners('data');
-        this._socket.removeAllListeners('close');
-    }
-    _reset() {
-        this._backend.reset();
-        this._sessionParameters = {};
-        this._processID = undefined;
-        this._secretKey = undefined;
-        this._saslSession = undefined;
-    }
-    _handleConnect() {
-        const socket = this._socket;
-        if (!socket)
-            return;
-        this._state = constants_js_1.ConnectionState.AUTHORIZING;
-        this._reset();
-        socket.on('data', (data) => this._handleData(data));
-        socket.on('error', (err) => this._handleError(err));
-        socket.on('close', () => this._handleClose());
-        this._send(this._frontend.getStartupMessage({
-            user: this.options.user || 'postgres',
-            database: this.options.database || '',
-            application_name: this.options.applicationName || '',
-        }));
-    }
-    _handleClose() {
-        this._reset();
-        this._socket = undefined;
-        this._state = constants_js_1.ConnectionState.CLOSED;
-        this.emit('close');
-    }
-    _handleError(err) {
-        if (this._state !== constants_js_1.ConnectionState.READY) {
-            this._socket?.end();
-        }
-        this.emit('error', err);
-    }
-    _handleData(data) {
-        this._backend.parse(data, (code, payload) => {
-            try {
-                switch (code) {
-                    case protocol_js_1.Protocol.BackendMessageCode.Authentication:
-                        this._handleAuthenticationMessage(payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.ErrorResponse:
-                        this.emit('error', new database_error_js_1.DatabaseError(payload));
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.NoticeResponse:
-                        this.emit('notice', payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.NotificationResponse:
-                        this.emit('notification', payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.ParameterStatus:
-                        this._handleParameterStatus(payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.BackendKeyData:
-                        this._handleBackendKeyData(payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.ReadyForQuery:
-                        if (this._state !== constants_js_1.ConnectionState.READY) {
-                            this._state = constants_js_1.ConnectionState.READY;
-                            this.emit('ready');
-                        }
-                        else
-                            this.emit('message', code, payload);
-                        break;
-                    case protocol_js_1.Protocol.BackendMessageCode.CommandComplete: {
-                        const msg = this._handleCommandComplete(payload);
-                        this.emit('message', code, msg);
-                        break;
-                    }
-                    default:
-                        this.emit('message', code, payload);
-                }
-            }
-            catch (e) {
-                this._handleError(e);
-            }
-        });
-    }
-    _resolvePassword(cb) {
-        (async () => {
-            const pass = typeof this.options.password === 'function'
-                ? await this.options.password()
-                : this.options.password;
-            cb(pass || '');
-        })().catch(err => this._handleError(err));
-    }
-    _handleAuthenticationMessage(msg) {
-        if (!msg) {
-            this.emit('authenticate');
-            return;
-        }
-        switch (msg.kind) {
-            case protocol_js_1.Protocol.AuthenticationMessageKind.CleartextPassword:
-                this._resolvePassword(password => {
-                    this._send(this._frontend.getPasswordMessage(password));
-                });
-                break;
-            case protocol_js_1.Protocol.AuthenticationMessageKind.MD5Password:
-                this._resolvePassword(password => {
-                    const md5 = (x) => node_crypto_1.default.createHash('md5').update(x, 'utf8').digest('hex');
-                    const l = md5(password + this.options.user);
-                    const r = md5(Buffer.concat([Buffer.from(l), msg.salt]));
-                    const pass = 'md5' + r;
-                    this._send(this._frontend.getPasswordMessage(pass));
-                });
-                break;
-            case protocol_js_1.Protocol.AuthenticationMessageKind.SASL: {
-                if (!msg.mechanisms.includes('SCRAM-SHA-256')) {
-                    throw new Error('SASL: Only mechanism SCRAM-SHA-256 is currently supported');
-                }
-                const saslSession = (this._saslSession = sasl_js_1.SASL.createSession(this.options.user || '', 'SCRAM-SHA-256'));
-                this._send(this._frontend.getSASLMessage(saslSession));
-                break;
-            }
-            case protocol_js_1.Protocol.AuthenticationMessageKind.SASLContinue: {
-                const saslSession = this._saslSession;
-                if (!saslSession)
-                    throw new Error('SASL: Session not started yet');
-                this._resolvePassword(password => {
-                    sasl_js_1.SASL.continueSession(saslSession, password, msg.data);
-                    const buf = this._frontend.getSASLFinalMessage(saslSession);
-                    this._send(buf);
-                });
-                break;
-            }
-            case protocol_js_1.Protocol.AuthenticationMessageKind.SASLFinal: {
-                const session = this._saslSession;
-                if (!session)
-                    throw new Error('SASL: Session not started yet');
-                sasl_js_1.SASL.finalizeSession(session, msg.data);
-                this._saslSession = undefined;
-                break;
-            }
-            default:
-                break;
-        }
-    }
-    _handleParameterStatus(msg) {
-        this._sessionParameters[msg.name] = msg.value;
-    }
-    _handleBackendKeyData(msg) {
-        this._processID = msg.processID;
-        this._secretKey = msg.secretKey;
-    }
-    _handleCommandComplete(msg) {
-        const m = msg.command && msg.command.match(COMMAND_RESULT_PATTERN);
-        const result = {
-            command: m[1],
-        };
-        if (m[3] != null) {
-            result.oid = parseInt(m[2], 10);
-            result.rowCount = parseInt(m[3], 10);
-        }
-        else if (m[2])
-            result.rowCount = parseInt(m[2], 10);
-        return result;
-    }
-    _send(data, cb) {
-        if (this._socket && this._socket.writable) {
-            this._socket.write(data, cb);
-        }
-    }
-}
-exports.PgSocket = PgSocket;

package/cjs/protocol/protocol.js

@@ -1,71 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Protocol = void 0;
-var Protocol;
-(function (Protocol) {
-    Protocol.VERSION_MAJOR = 3;
-    Protocol.VERSION_MINOR = 0;
-    // https://www.postgresql.org/docs/9.3/protocol-message-formats.html
-    let BackendMessageCode;
-    (function (BackendMessageCode) {
-        BackendMessageCode[BackendMessageCode["Authentication"] = 82] = "Authentication";
-        BackendMessageCode[BackendMessageCode["BackendKeyData"] = 75] = "BackendKeyData";
-        BackendMessageCode[BackendMessageCode["BindComplete"] = 50] = "BindComplete";
-        BackendMessageCode[BackendMessageCode["CloseComplete"] = 51] = "CloseComplete";
-        BackendMessageCode[BackendMessageCode["CommandComplete"] = 67] = "CommandComplete";
-        BackendMessageCode[BackendMessageCode["CopyData"] = 100] = "CopyData";
-        BackendMessageCode[BackendMessageCode["CopyDone"] = 99] = "CopyDone";
-        BackendMessageCode[BackendMessageCode["CopyInResponse"] = 103] = "CopyInResponse";
-        BackendMessageCode[BackendMessageCode["CopyOutResponse"] = 72] = "CopyOutResponse";
-        BackendMessageCode[BackendMessageCode["CopyBothResponse"] = 87] = "CopyBothResponse";
-        BackendMessageCode[BackendMessageCode["DataRow"] = 68] = "DataRow";
-        BackendMessageCode[BackendMessageCode["EmptyQueryResponse"] = 73] = "EmptyQueryResponse";
-        BackendMessageCode[BackendMessageCode["ErrorResponse"] = 69] = "ErrorResponse";
-        BackendMessageCode[BackendMessageCode["FunctionCallResponse"] = 86] = "FunctionCallResponse";
-        BackendMessageCode[BackendMessageCode["NegotiateProtocolVersion"] = 118] = "NegotiateProtocolVersion";
-        BackendMessageCode[BackendMessageCode["NoData"] = 110] = "NoData";
-        BackendMessageCode[BackendMessageCode["NoticeResponse"] = 78] = "NoticeResponse";
-        BackendMessageCode[BackendMessageCode["NotificationResponse"] = 65] = "NotificationResponse";
-        BackendMessageCode[BackendMessageCode["ParameterDescription"] = 116] = "ParameterDescription";
-        BackendMessageCode[BackendMessageCode["ParameterStatus"] = 83] = "ParameterStatus";
-        BackendMessageCode[BackendMessageCode["ParseComplete"] = 49] = "ParseComplete";
-        BackendMessageCode[BackendMessageCode["PortalSuspended"] = 115] = "PortalSuspended";
-        BackendMessageCode[BackendMessageCode["ReadyForQuery"] = 90] = "ReadyForQuery";
-        BackendMessageCode[BackendMessageCode["RowDescription"] = 84] = "RowDescription";
-    })(BackendMessageCode = Protocol.BackendMessageCode || (Protocol.BackendMessageCode = {}));
-    let FrontendMessageCode;
-    (function (FrontendMessageCode) {
-        FrontendMessageCode[FrontendMessageCode["Bind"] = 66] = "Bind";
-        FrontendMessageCode[FrontendMessageCode["Close"] = 67] = "Close";
-        FrontendMessageCode[FrontendMessageCode["CopyData"] = 100] = "CopyData";
-        FrontendMessageCode[FrontendMessageCode["CopyDone"] = 99] = "CopyDone";
-        FrontendMessageCode[FrontendMessageCode["CopyFail"] = 102] = "CopyFail";
-        FrontendMessageCode[FrontendMessageCode["Describe"] = 68] = "Describe";
-        FrontendMessageCode[FrontendMessageCode["Execute"] = 69] = "Execute";
-        FrontendMessageCode[FrontendMessageCode["Flush"] = 72] = "Flush";
-        FrontendMessageCode[FrontendMessageCode["FunctionCall"] = 70] = "FunctionCall";
-        FrontendMessageCode[FrontendMessageCode["Parse"] = 80] = "Parse";
-        FrontendMessageCode[FrontendMessageCode["PasswordMessage"] = 112] = "PasswordMessage";
-        FrontendMessageCode[FrontendMessageCode["Query"] = 81] = "Query";
-        FrontendMessageCode[FrontendMessageCode["Sync"] = 83] = "Sync";
-        FrontendMessageCode[FrontendMessageCode["Terminate"] = 88] = "Terminate";
-    })(FrontendMessageCode = Protocol.FrontendMessageCode || (Protocol.FrontendMessageCode = {}));
-    let AuthenticationMessageKind;
-    (function (AuthenticationMessageKind) {
-        AuthenticationMessageKind["KerberosV5"] = "KerberosV5";
-        AuthenticationMessageKind["CleartextPassword"] = "CleartextPassword";
-        AuthenticationMessageKind["MD5Password"] = "MD5Password";
-        AuthenticationMessageKind["SCMCredential"] = "SCMCredential";
-        AuthenticationMessageKind["GSS"] = "GSS";
-        AuthenticationMessageKind["SSPI"] = "SSPI";
-        AuthenticationMessageKind["GSSContinue"] = "GSSContinue";
-        AuthenticationMessageKind["SASL"] = "SASL";
-        AuthenticationMessageKind["SASLContinue"] = "SASLContinue";
-        AuthenticationMessageKind["SASLFinal"] = "SASLFinal";
-    })(AuthenticationMessageKind = Protocol.AuthenticationMessageKind || (Protocol.AuthenticationMessageKind = {}));
-    let DataFormat;
-    (function (DataFormat) {
-        DataFormat[DataFormat["text"] = 0] = "text";
-        DataFormat[DataFormat["binary"] = 1] = "binary";
-    })(DataFormat = Protocol.DataFormat || (Protocol.DataFormat = {}));
-})(Protocol || (exports.Protocol = Protocol = {}));

package/cjs/protocol/sasl.js

@@ -1,108 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SASL = void 0;
-const tslib_1 = require("tslib");
-const crypto_1 = tslib_1.__importDefault(require("crypto"));
-var SASL;
-(function (SASL) {
-    const CLIENT_KEY = 'Client Key';
-    const SERVER_KEY = 'Server Key';
-    const GS2_HEADER = 'n,,';
-    function createSession(username, mechanism) {
-        const nonce = crypto_1.default.randomBytes(18).toString('base64');
-        const clientFirstMessage = `${GS2_HEADER}${firstMessageBare(username, nonce)}`;
-        return {
-            username,
-            mechanism,
-            nonce,
-            clientFirstMessage,
-        };
-    }
-    SASL.createSession = createSession;
-    function continueSession(session, password, data) {
-        const s = data.toString();
-        const items = s.split(',');
-        let nonce = '';
-        let salt = '';
-        let iteration = 0;
-        for (const i of items) {
-            switch (i[0]) {
-                case 'r':
-                    nonce = i.substring(2);
-                    break;
-                case 's':
-                    salt = i.substring(2);
-                    break;
-                case 'i':
-                    iteration = parseInt(i.substring(2), 10);
-                    break;
-                default:
-                    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');
-        if (!nonce.startsWith(session.nonce))
-            throw new Error('SASL: Server nonce does not start with client nonce');
-        const serverFirstMessage = `r=${nonce},s=${salt},i=${iteration}`;
-        const clientFinalMessageWithoutProof = `c=${encode64(GS2_HEADER)},r=${nonce}`;
-        const authMessage = `${firstMessageBare(session.username, session.nonce)},${serverFirstMessage},${clientFinalMessageWithoutProof}`;
-        const saltPass = hi(password, salt, iteration);
-        const clientKey = hmac(saltPass, CLIENT_KEY);
-        const storedKey = hash(clientKey);
-        const clientSignature = hmac(storedKey, authMessage);
-        const clientProofBytes = xor(clientKey, clientSignature);
-        const clientProof = clientProofBytes.toString('base64');
-        const serverKey = hmac(saltPass, SERVER_KEY);
-        const serverSignatureBytes = hmac(serverKey, authMessage);
-        session.serverSignature = serverSignatureBytes.toString('base64');
-        session.clientFinalMessage =
-            clientFinalMessageWithoutProof + ',p=' + clientProof;
-    }
-    SASL.continueSession = continueSession;
-    function finalizeSession(session, data) {
-        let serverSignature = '';
-        const arr = data.split(',');
-        for (const s of arr) {
-            if (s[0] === 'v')
-                serverSignature = s.substr(2);
-        }
-        if (serverSignature !== session.serverSignature)
-            throw new Error('SASL: Server signature does not match');
-    }
-    SASL.finalizeSession = finalizeSession;
-    const firstMessageBare = function (username, nonce) {
-        return `n=${username},r=${nonce}`;
-    };
-    /**
-     * Hi() is, essentially, PBKDF2 [RFC2898] with HMAC() as the
-     * pseudorandom function (PRF) and with dkLen == output length of
-     * HMAC() == output length of H()
-     */
-    const hi = function (text, salt, iterations) {
-        return crypto_1.default.pbkdf2Sync(text, Buffer.from(salt, 'base64'), iterations, 32, 'sha256');
-    };
-    const encode64 = (str) => Buffer.from(str).toString('base64');
-    const hmac = function (key, msg) {
-        return crypto_1.default.createHmac('sha256', key).update(msg).digest();
-    };
-    const hash = function (data) {
-        return crypto_1.default.createHash('sha256').update(data).digest();
-    };
-    const xor = function (a, b) {
-        a = Buffer.isBuffer(a) ? a : Buffer.from(a);
-        b = Buffer.isBuffer(b) ? b : Buffer.from(b);
-        if (a.length !== b.length)
-            throw new Error('Buffers must be of the same length');
-        const l = a.length;
-        const out = Buffer.allocUnsafe(l);
-        for (let i = 0; i < l; i++) {
-            out[i] = a[i] ^ b[i];
-        }
-        return out;
-    };
-})(SASL || (exports.SASL = SASL = {}));