more and delete old tests

Author: baileympearson

README.md

@@ -126,7 +126,7 @@ NOTE: The test suite requires an active kerberos deployment.
 ## Functions
 
 <dl>
-<dt><a href="#checkPassword">checkPassword(username, password, service, [defaultRealm])</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#checkPassword">checkPassword(username, password, service, [defaultRealm])</a> ⇒ <code>Promise.&lt;null&gt;</code></dt>
 <dd><p>This function provides a simple way to verify that a user name and password
 match those normally used for Kerberos authentication.
 It does this by checking that the supplied user name and password can be
@@ -145,10 +145,10 @@ security could be compromised if you do.</p>
 <dd><p>This function returns the service principal for the server given a service type and hostname.</p>
 <p>Details are looked up via the <code>/etc/keytab</code> file.</p>
 </dd>
-<dt><a href="#initializeClient">initializeClient(service, [options])</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#initializeClient">initializeClient(service, [options])</a> ⇒ <code><a href="#KerberosClient">Promise.&lt;KerberosClient&gt;</a></code></dt>
 <dd><p>Initializes a context for client-side authentication with the given service principal.</p>
 </dd>
-<dt><a href="#initializeServer">initializeServer(service)</a> ⇒ <code>Promise</code></dt>
+<dt><a href="#initializeServer">initializeServer(service)</a> ⇒ <code><a href="#KerberosServer">Promise.&lt;KerberosServer&gt;</a></code></dt>
 <dd><p>Initializes a context for server-side authentication with the given service principal.</p>
 </dd>
 </dl>
@@ -185,7 +185,6 @@ security could be compromised if you do.</p>
 
 Processes a single kerberos client-side step using the supplied server challenge.
 
-**Returns**: <code>Promise</code> - returns Promise  
 <a name="KerberosClient+wrap"></a>
 
 ### *kerberosClient*.wrap(challenge, [options])
@@ -199,7 +198,6 @@ Processes a single kerberos client-side step using the supplied server challenge
 
 Perform the client side kerberos wrap step.
 
-**Returns**: <code>Promise</code> - returns Promise  
 <a name="KerberosClient+unwrap"></a>
 
 ### *kerberosClient*.unwrap(challenge)
@@ -210,7 +208,6 @@ Perform the client side kerberos wrap step.
 
 Perform the client side kerberos unwrap step
 
-**Returns**: <code>Promise</code> - returns Promise  
 <a name="KerberosServer"></a>
 
 ## KerberosServer
@@ -233,7 +230,6 @@ Perform the client side kerberos unwrap step
 
 Processes a single kerberos server-side step using the supplied client data.
 
-**Returns**: <code>Promise</code> - returns Promise  
 <a name="checkPassword"></a>
 
 ## checkPassword(username, password, service, [defaultRealm])
@@ -261,7 +257,7 @@ IMPORTANT: This method is vulnerable to KDC spoofing attacks and it should
 only be used for testing. Do not use this in any production system - your
 security could be compromised if you do.
 
-**Returns**: <code>Promise</code> - returns Promise  
+**Returns**: <code>Promise.&lt;null&gt;</code> - returns Promise that rejects if the password is invalid  
 <a name="principalDetails"></a>
 
 ## principalDetails(service, hostname)
@@ -290,7 +286,7 @@ Details are looked up via the `/etc/keytab` file.
 
 Initializes a context for client-side authentication with the given service principal.
 
-**Returns**: <code>Promise</code> - returns Promise  
+**Returns**: [<code>Promise.&lt;KerberosClient&gt;</code>](#KerberosClient) - returns Promise  
 <a name="initializeServer"></a>
 
 ## initializeServer(service)
@@ -301,4 +297,4 @@ Initializes a context for client-side authentication with the given service prin
 
 Initializes a context for server-side authentication with the given service principal.
 
-**Returns**: <code>Promise</code> - returns Promise  
+**Returns**: [<code>Promise.&lt;KerberosServer&gt;</code>](#KerberosServer) - returns Promise  

lib/kerberos.js

@@ -39,7 +39,7 @@ const originalStep = KerberosClient.prototype.step;
  * @kind function
  * @memberof KerberosClient
  * @param {string} challenge A string containing the base64-encoded server data (which may be empty for the first step)
- * @return {Promise} returns Promise
+ * @return {Promise<string>}
  */
 KerberosClient.prototype.step = async function step(challenge) {
   return await promisify(originalStep.bind(this))(challenge);
@@ -55,7 +55,7 @@ const originalWrap = KerberosClient.prototype.wrap;
  * @param {object} [options] Optional settings
  * @param {string} [options.user] The user to authorize
  * @param {boolean} [options.protect] Indicates if the wrap should request message confidentiality
- * @return {Promise} returns Promise
+ * @return {Promise<string>}
  */
 KerberosClient.prototype.wrap = async function wrap(challenge, options = {}) {
   return await promisify(originalWrap.bind(this))(challenge, options);
@@ -68,7 +68,7 @@ const originalUnwrap = KerberosClient.prototype.unwrap;
  * @kind function
  * @memberof KerberosClient
  * @param {string} challenge A string containing the base64-encoded server data
- * @return {Promise} returns Promise
+ * @return {Promise<string>}
  */
 KerberosClient.prototype.unwrap = async function unwrap(challenge) {
   return await promisify(originalUnwrap.bind(this))(challenge);
@@ -90,7 +90,7 @@ const originalServerStep = KerberosServer.prototype.step;
  * @kind function
  * @memberof KerberosServer
  * @param {string} challenge A string containing the base64-encoded client data
- * @return {Promise} returns Promise
+ * @return {Promise<KerberosServer>}
  */
 KerberosServer.prototype.step = async function step(challenge) {
   return await promisify(originalServerStep.bind(this))(challenge);
@@ -118,7 +118,7 @@ KerberosServer.prototype.step = async function step(challenge) {
  * @param {string} password The password for the user.
  * @param {string} service The Kerberos service to check access for.
  * @param {string} [defaultRealm] The default realm to use if one is not supplied in the user argument.
- * @return {Promise} returns Promise
+ * @return {Promise<null>} returns Promise that rejects if the password is invalid
  */
 async function checkPassword(username, password, service, defaultRealm) {
   return await promisify(kerberos.checkPassword)(username, password, service, defaultRealm);
@@ -147,7 +147,7 @@ async function principalDetails(service, hostname) {
  * @param {string} [options.principal] Optional string containing the client principal in the form 'user@realm' (e.g. '[email protected]').
  * @param {number} [options.flags] Optional integer used to set GSS flags. (e.g.  `GSS_C_DELEG_FLAG\|GSS_C_MUTUAL_FLAG\|GSS_C_SEQUENCE_FLAG` will allow for forwarding credentials to the remote host)
  * @param {number} [options.mechOID] Optional GSS mech OID. Defaults to None (GSS_C_NO_OID). Other possible values are `GSS_MECH_OID_KRB5`, `GSS_MECH_OID_SPNEGO`.
- * @return {Promise} returns Promise
+ * @return {Promise<KerberosClient>} returns Promise
  */
 async function initializeClient(service, options = { mechOID: GSS_C_NO_OID }) {
   return await promisify(kerberos.initializeClient)(service, options);
@@ -158,7 +158,7 @@ async function initializeClient(service, options = { mechOID: GSS_C_NO_OID }) {
  *
  * @kind function
  * @param {string} service A string containing the service principal in the form 'type@fqdn' (e.g. '[email protected]').
- * @return {Promise} returns Promise
+ * @return {Promise<KerberosServer>} returns Promise
  */
 async function initializeServer(service) {
   return await promisify(kerberos.initializeServer)(service);

package-lock.json

@@ -42,11 +42,9 @@
     "eslint-plugin-prettier": "^5.5.4",
     "jsdoc-to-markdown": "^9.1.2",
     "mocha": "^11.7.1",
-    "mongodb": "^6.18.0",
     "node-gyp": "^10.1.0",
     "prebuild": "^13.0.1",
-    "prettier": "^3.6.2",
-    "request": "^2.88.2"
+    "prettier": "^3.6.2"
   },
   "overrides": {
     "prebuild": {

package.json

@@ -27,10 +27,8 @@ describe('Kerberos', function () {
   it('should check a given password against a kerberos server', async function () {
     const service = `HTTP/${hostname}`;
 
-    // Test with correct password - should not throw
     await kerberos.checkPassword(username, password, service, realm.toUpperCase());
 
-    // Test with incorrect password - should throw
     const error = await kerberos
       .checkPassword(username, 'incorrect-password', service, realm.toUpperCase())
       .catch(e => e);
@@ -50,6 +48,7 @@ describe('Kerberos', function () {
     expect(client.contextComplete).to.be.false;
 
     const serverResponse = await server.step(clientResponse);
+
     expect(client.contextComplete).to.be.false;
 
     await client.step(serverResponse);