gremlin

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Source: driver/auth/mechanisms/sasl-mechanism-plain.js</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Source: driver/auth/mechanisms/sasl-mechanism-plain.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>/* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements. See the NOTICE file * distributed with this work for additional information * regarding copyright ownership. The ASF licenses this file * to you under the Apache License, Version 2.0 (the * "License"); you may not use this file except in compliance * with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, * software distributed under the License is distributed on an * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * KIND, either express or implied. See the License for the * specific language governing permissions and limitations * under the License. */ 'use strict'; const { Buffer } = require('buffer'); const SaslMechanismBase = require('./sasl-mechanism-base'); class SaslMechanismPlain extends SaslMechanismBase { /** * Creates a new instance of SaslMechanismPlain. * @param {Object} [options] The mechanism options. * @param {String} [options.authzid] The identity of the client. * @param {String} [options.username] The identity of user with access to server. * @param {String} [options.password] The password of user with access to server. * @constructor */ constructor(options) { super(options); if ( this._options.username === undefined || this._options.username === null || this._options.username.length === 0 || this._options.password === undefined || this._options.password === null || this._options.password.length === 0 ) { throw new Error('Missing credentials for SASL PLAIN mechanism'); } } /** * Returns the name of the mechanism */ get name() { return 'PLAIN'; } /** * Evaluates the challenge from the server and returns appropriate response. * @param {String} challenge Challenge string presented by the server. * @return {Object} A Promise that resolves to a valid sasl response object. */ evaluateChallenge(challenge) { if (this._hasInitialResponse(challenge)) { return Promise.resolve({ saslMechanism: this.name, sasl: this._saslArgument(this._options.authzid, this._options.username, this._options.password), }); } return Promise.resolve({ sasl: this._saslArgument(this._options.authzid, this._options.username, this._options.password), }); } /** * Generates a base64 encoded sasl argument based on the given parameters. * @param {String} authzid Identitiy of the client. * @param {String} username The identity of user with access to server. * @param {String} password The password of user with access to server. */ _saslArgument(authzid, username, password) { if (authzid === undefined || authzid === null) { authzid = ''; } if (username === undefined || username === null) { username = ''; } if (password === undefined || password.length === null) { password = ''; } return Buffer.from(`${authzid}\0${username}\0${password}`).toString('base64'); } /** * Checks challenge to see if we have the initial sasl response from the server. * @param {String} challenge The challenge string from the server. * @return {Boolean} */ _hasInitialResponse(challenge) { if (challenge === undefined || challenge === null) { return false; } return true; } } module.exports = SaslMechanismPlain; </code></pre> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AnonymousTraversalSource.html">AnonymousTraversalSource</a></li><li><a href="Authenticator.html">Authenticator</a></li><li><a href="Bytecode.html">Bytecode</a></li><li><a href="CardinalityValue.html">CardinalityValue</a></li><li><a href="Client.html">Client</a></li><li><a href="Connection.html">Connection</a></li><li><a href="DriverRemoteConnection.html">DriverRemoteConnection</a></li><li><a href="EdgeLabelVerificationStrategy.html">EdgeLabelVerificationStrategy</a></li><li><a href="Graph.html">Graph</a></li><li><a href="GraphSON2Reader.html">GraphSON2Reader</a></li><li><a href="GraphSON2Writer.html">GraphSON2Writer</a></li><li><a href="GraphSON3Reader.html">GraphSON3Reader</a></li><li><a href="GraphSON3Writer.html">GraphSON3Writer</a></li><li><a href="GraphTraversal.html">GraphTraversal</a></li><li><a href="GraphTraversalSource.html">GraphTraversalSource</a></li><li><a href="HaltedTraverserStrategy.html">HaltedTraverserStrategy</a></li><li><a href="MatchAlgorithmStrategy.html">MatchAlgorithmStrategy</a></li><li><a href="module.exports.html">exports</a></li><li><a href="P.html">P</a></li><li><a href="PartitionStrategy.html">PartitionStrategy</a></li><li><a href="Path.html">Path</a></li><li><a href="PlainTextSaslAuthenticator.html">PlainTextSaslAuthenticator</a></li><li><a href="ProductiveByStrategy.html">ProductiveByStrategy</a></li><li><a href="RemoteConnection.html">RemoteConnection</a></li><li><a href="RemoteStrategy.html">RemoteStrategy</a></li><li><a href="RemoteTraversal.html">RemoteTraversal</a></li><li><a href="ReservedKeysVerificationStrategy.html">ReservedKeysVerificationStrategy</a></li><li><a href="ResponseError.html">ResponseError</a></li><li><a href="ResultSet.html">ResultSet</a></li><li><a href="SaslAuthenticator.html">SaslAuthenticator</a></li><li><a href="SaslMechanismBase.html">SaslMechanismBase</a></li><li><a href="SaslMechanismPlain.html">SaslMechanismPlain</a></li><li><a href="SeedStrategy.html">SeedStrategy</a></li><li><a href="SubgraphStrategy.html">SubgraphStrategy</a></li><li><a href="TextP.html">TextP</a></li><li><a href="Transaction.html">Transaction</a></li><li><a href="Translator.html">Translator</a></li><li><a href="TraversalStrategies.html">TraversalStrategies</a></li><li><a href="TraversalStrategy.html">TraversalStrategy</a></li><li><a href="TypeSerializer.html">TypeSerializer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#DataType">DataType</a></li><li><a href="global.html#statics">statics</a></li><li><a href="global.html#toArrayBuffer">toArrayBuffer</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Fri Aug 08 2025 09:56:42 GMT-0700 (Pacific Daylight Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>