Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide Microsoft.AspNetCore.Authentication.Negotiate package README #57772

Merged
merged 3 commits into from
Sep 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 & 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).
Loading