Skip to content

Commit

Permalink
Provide Microsoft.AspNetCore.Authentication.Negotiate package README (
Browse files Browse the repository at this point in the history
#57772)

Co-authored-by: Stephen Halter <halter73@gmail.com>
  • Loading branch information
MackinnonBuck and halter73 committed Sep 11, 2024
1 parent ffd5a38 commit 5b1584e
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions src/Security/Authentication/Negotiate/src/PACKAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## About

`Microsoft.AspNetCore.Authentication.Negotiate` contains an authentication handler used to authenticate requests using Windows Authentication (also known as Negotiate, Kerberos, or NTLM).

## How to Use

To use `Microsoft.AspNetCore.Authentication.Negotiate`, follow these steps:

### Installation

```shell
dotnet add package Microsoft.AspNetCore.Authentication.Negotiate
```

### Configuration

To use the middleware, configure it in your ASP.NET Core app's `Program.cs`:

```csharp
builder.Services.AddAuthentication(NegotiateDefaults.AuthenticationScheme)
.AddNegotiate();

builder.Services.AddAuthorization();

var app = builder.Build();

Next, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/security/authentication/windowsauth) for configuration details specific to your app's web server.
## Main Types

The main types provided by this package are:

* `NegotiateOptions`: Represents the options for configuring Negotiate Authentication handler behavior
* `NegotiateHandler`: The authentication handler responsible for processing Negotiate authentication requests and generating the appropriate authentication ticket

## Additional Documentation

For additional documentation and examples, refer to the [official documentation](https://learn.microsoft.com/aspnet/core/security/authentication/windowsauth) on Windows Authentication in ASP.NET Core.
## Feedback &amp; Contributing

`Microsoft.AspNetCore.Authentication.Negotiate` is released as open-source under the [MIT license](https://licenses.nuget.org/MIT). Bug reports and contributions are welcome at [the GitHub repository](https://github.com/dotnet/aspnetcore).

0 comments on commit 5b1584e

Please sign in to comment.