PromiseThis function provides a simple way to verify that a user name and password\nmatch those normally used for Kerberos authentication.\nIt does this by checking that the supplied user name and password can be\nused to get a ticket for the supplied service.\nIf the user name does not contain a realm, then the default realm supplied\nis used.
\nFor this to work properly the Kerberos must be configured properly on this\nmachine.\nThat will likely mean ensuring that the edu.mit.Kerberos preference file\nhas the correct realms and KDCs listed.
\nIMPORTANT: This method is vulnerable to KDC spoofing attacks and it should\nonly be used for testing. Do not use this in any production system - your\nsecurity could be compromised if you do.
\nPromiseThis function returns the service principal for the server given a service type and hostname.
\nDetails are looked up via the /etc/keytab file.
PromiseInitializes a context for client-side authentication with the given service principal.
\nPromiseInitializes a context for server-side authentication with the given service principal.
\nstring | The username used for authentication |\n| response | string | The last response received during authentication steps |\n| responseConf | string | Indicates whether confidentiality was applied or not (GSSAPI only) |\n| contextComplete | boolean | Indicates that authentication has successfully completed or not |\n\n\n* [KerberosClient](#KerberosClient)\n\n * [.step(challenge, [callback])](#KerberosClient+step)\n\n * [.wrap(challenge, [options], [callback])](#KerberosClient+wrap)\n\n * [.unwrap(challenge, [callback])](#KerberosClient+unwrap)\n\n\n\n\n### *kerberosClient*.step(challenge, [callback])\n\n| Param | Type | Description |\n| --- | --- | --- |\n| challenge | string | A string containing the base64-encoded server data (which may be empty for the first step) |\n| [callback] | function | |\n\nProcesses a single kerberos client-side step using the supplied server challenge.\n\n**Returns**: Promise - returns Promise if no callback passed \n\n\n### *kerberosClient*.wrap(challenge, [options], [callback])\n\n| Param | Type | Description |\n| --- | --- | --- |\n| challenge | string | The response returned after calling `unwrap` |\n| [options] | object | Optional settings |\n| [options.user] | string | The user to authorize |\n| [callback] | function | |\n\nPerform the client side kerberos wrap step.\n\n**Returns**: Promise - returns Promise if no callback passed \n\n\n### *kerberosClient*.unwrap(challenge, [callback])\n\n| Param | Type | Description |\n| --- | --- | --- |\n| challenge | string | A string containing the base64-encoded server data |\n| [callback] | function | |\n\nPerform the client side kerberos unwrap step\n\n**Returns**: Promise - returns Promise if no callback passed \n\n\n## KerberosServer\n**Properties**\n\n| Name | Type | Description |\n| --- | --- | --- |\n| username | string | The username used for authentication |\n| response | string | The last response received during authentication steps |\n| targetName | string | The target used for authentication |\n| contextComplete | boolean | Indicates that authentication has successfully completed or not |\n\n\n\n### *kerberosServer*.step(challenge, [callback])\n\n| Param | Type | Description |\n| --- | --- | --- |\n| challenge | string | A string containing the base64-encoded client data |\n| [callback] | function | |\n\nProcesses a single kerberos server-side step using the supplied client data.\n\n**Returns**: Promise - returns Promise if no callback passed \n\n\n## checkPassword(username, password, service, [defaultRealm], [callback])\n\n| Param | Type | Description |\n| --- | --- | --- |\n| username | string | The Kerberos user name. If no realm is supplied, then the `defaultRealm` will be used. |\n| password | string | The password for the user. |\n| service | string | The Kerberos service to check access for. |\n| [defaultRealm] | string | The default realm to use if one is not supplied in the user argument. |\n| [callback] | function | |\n\nThis function provides a simple way to verify that a user name and password\nmatch those normally used for Kerberos authentication.\nIt does this by checking that the supplied user name and password can be\nused to get a ticket for the supplied service.\nIf the user name does not contain a realm, then the default realm supplied\nis used.\n\nFor this to work properly the Kerberos must be configured properly on this\nmachine.\nThat will likely mean ensuring that the edu.mit.Kerberos preference file\nhas the correct realms and KDCs listed.\n\nIMPORTANT: This method is vulnerable to KDC spoofing attacks and it should\nonly be used for testing. Do not use this in any production system - your\nsecurity could be compromised if you do.\n\n**Returns**: Promise - returns Promise if no callback passed \n\n\n## principalDetails(service, hostname, [callback])\n\n| Param | Type | Description |\n| --- | --- | --- |\n| service | string | The Kerberos service type for the server. |\n| hostname | string | The hostname of the server. |\n| [callback] | function | |\n\nThis function returns the service principal for the server given a service type and hostname.\n\nDetails are looked up via the `/etc/keytab` file.\n\n**Returns**: Promise - returns Promise if no callback passed \n\n\n## initializeClient(service, [options], [callback])\n\n| Param | Type | Description |\n| --- | --- | --- |\n| service | string | A string containing the service principal in the form 'type@fqdn' (e.g. 'imap@mail.apple.com'). |\n| [options] | object | Optional settings |\n| [options.principal] | string | Optional string containing the client principal in the form 'user@realm' (e.g. 'jdoe@example.com'). |\n| [options.gssFlags] | number | 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) |\n| [options.mechOID] | number | Optional GSS mech OID. Defaults to None (GSS_C_NO_OID). Other possible values are `GSS_MECH_OID_KRB5`, `GSS_MECH_OID_SPNEGO`. |\n| [callback] | function | |\n\nInitializes a context for client-side authentication with the given service principal.\n\n**Returns**: Promise - returns Promise if no callback passed \n\n\n## initializeServer(service, [callback])\n\n| Param | Type | Description |\n| --- | --- | --- |\n| service | string | A string containing the service principal in the form 'type@fqdn' (e.g. 'imap@mail.apple.com'). |\n| [callback] | function | |\n\nInitializes a context for server-side authentication with the given service principal.\n\n**Returns**: Promise - returns Promise if no callback passed \n","_attachments":{},"homepage":"https://github.com/mongodb-js/kerberos#readme","bugs":{"url":"https://jira.mongodb.org/projects/NODE/issues/"},"license":"Apache-2.0"}