[JAVA-2717] Remove reference to SSPI in GSSAPI reference documentation for the async driver Created: 26/Dec/17  Updated: 28/Oct/23  Resolved: 09/Jan/18

Status: Closed
Project: Java Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 3.7.0

Type: Improvement Priority: Major - P3
Reporter: Jeffrey Yemin Assignee: Jeffrey Yemin
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Related

 Description   

In docs/reference/content/driver-async/tutorials/authentication.md:

The `GSSAPI` authentication mechanism is supported only in the following environments:
 
* Linux: Java 6 and above
* Windows: Java 7 and above with [SSPI](https://msdn.microsoft.com/en-us/library/windows/desktop/aa380493) 

The reference to SSPI should be removed, as the Oracle JDK does not use SSPI for its GSSAPI implementation.

The documentation should be made consistent with the sync version in docs/reference/content/driver/tutorials/authentication.md, which doesn't include that (or any other caveat for that matter).



 Comments   
Comment by Githook User [ 09/Jan/18 ]

Author:

{'name': 'Jeff Yemin', 'username': 'jyemin', 'email': 'jeff.yemin@10gen.com'}

Message: JAVA-2717: Expand on Windows limitations for GSSAPI authentication in the reference documentation,
including links to relevant Oracle JDK issues and Stack Overflow question.

Also add missing documentation of GSSAPI mechanism properties in the synchronous driver reference documentation
Branch: 3.6.x
https://github.com/mongodb/mongo-java-driver/commit/c103e68b15da5980f33e956280fa953a0f620767

Comment by Githook User [ 09/Jan/18 ]

Author:

{'name': 'Jeff Yemin', 'username': 'jyemin', 'email': 'jeff.yemin@10gen.com'}

Message: JAVA-2717: Expand on Windows limitations for GSSAPI authentication in the reference documentation,
including links to relevant Oracle JDK issues and Stack Overflow question.

Also add missing documentation of GSSAPI mechanism properties in the synchronous driver reference documentation
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/ca89c6991f8dc4c0fb0c050110371e871f80c6b2

Comment by Jeffrey Yemin [ 26/Dec/17 ]

Additionally, this documentation is in driver-async but missing in driver:

Depending on the Kerberos setup, additional property specifications may be required, either via the application code or, in some cases, the [withMechanismProperty()]({{<apiref "com/mongodb/MongoCredential.html#withMechanismProperty-java.lang.String-T-">}}) method of the `MongoCredential` instance:
 
- **[`SERVICE_NAME`]({{< apiref "com/mongodb/MongoCredential.html#SERVICE_NAME_KEY" >}})**
 
 
- **[`CANONICALIZE_HOST_NAME`]({{< apiref "com/mongodb/MongoCredential.html#CANONICALIZE_HOST_NAME_KEY" >}})**
 
 
- **[`JAVA_SUBJECT`]({{< apiref "com/mongodb/MongoCredential.html#JAVA_SUBJECT_KEY" >}})**
 
- **[`JAVA_SASL_CLIENT_PROPERTIES`]({{< apiref "com/mongodb/MongoCredential.html#JAVA_SASL_CLIENT_PROPERTIES_KEY" >}})**
 
For example, to specify the `SERVICE_NAME` property via the `MongoCredential` object:
 
 
```java
credential = credential.withMechanismProperty(MongoCredential.SERVICE_NAME_KEY, "othername");
```
 
Or via the `ConnectionString`:
 
```
mongodb://username%40MYREALM.com@myserver/?authMechanism=GSSAPI&authMechanismProperties=SERVICE_NAME:othername
```

Generated at Thu Feb 08 08:57:54 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.