Dotnetopenauth .NET Core (jak to działa dla programistów)

Konfiguracja DotNetOpenAuth .NET Core w projektach .NET

Aby rozpocząć korzystanie z DotNetOpenAuth .NET Core w projektach .NET obsługiwanych przez technologie Microsoft, wykonaj następujące czynności:

1. Otwórz swój projekt w Visual Studio.
2. Przejdź do okna Solution Explorer.
3. Kliknij prawym przyciskiem myszy nazwę swojego projektu.
4. Wybierz Manage NuGet Packages.
5. W menedżerze pakietów NuGet wyszukaj DotNetOpenAuth.NetCore i inne pakiety NuGet.
6. Kliknij Install, aby dodać go do swojego projektu.

Spowoduje to dodanie biblioteki DotNetOpenAuth .NET Core do projektu, zapewniając obsługę integracji funkcji uwierzytelniania.

Podstawowy przykład kodu wykorzystujący DotNetOpenAuth .NET Core

Oto prosty przykład pokazujący, jak skonfigurować uwierzytelnianie OAuth2 w aplikacji przy użyciu DotNetOpenAuth .NET Core:

using DotNetOpenAuth.OAuth2;

// Initialize the OAuth2 client with the authorization server details
var client = new WebServerClient(new AuthorizationServerDescription
{
    TokenEndpoint = new Uri("https://your-auth-server.com/token"),
    AuthorizationEndpoint = new Uri("https://your-auth-server.com/authorize")
}, "your-client-id", "your-client-secret");

// Start the authentication process and get the authorization state
IAuthorizationState state = client.ProcessUserAuthorization();
if (state != null && state.IsAuthorized)
{
    // Authorized successfully, now you can access protected resources
}

using DotNetOpenAuth.OAuth2;

// Initialize the OAuth2 client with the authorization server details
var client = new WebServerClient(new AuthorizationServerDescription
{
    TokenEndpoint = new Uri("https://your-auth-server.com/token"),
    AuthorizationEndpoint = new Uri("https://your-auth-server.com/authorize")
}, "your-client-id", "your-client-secret");

// Start the authentication process and get the authorization state
IAuthorizationState state = client.ProcessUserAuthorization();
if (state != null && state.IsAuthorized)
{
    // Authorized successfully, now you can access protected resources
}

Imports DotNetOpenAuth.OAuth2

' Initialize the OAuth2 client with the authorization server details
Private client = New WebServerClient(New AuthorizationServerDescription With {
	.TokenEndpoint = New Uri("https://your-auth-server.com/token"),
	.AuthorizationEndpoint = New Uri("https://your-auth-server.com/authorize")
}, "your-client-id", "your-client-secret")

' Start the authentication process and get the authorization state
Private state As IAuthorizationState = client.ProcessUserAuthorization()
If state IsNot Nothing AndAlso state.IsAuthorized Then
	' Authorized successfully, now you can access protected resources
End If

Ten fragment kodu konfiguruje klienta OAuth2 przy użyciu DotNetOpenAuth .NET Core, łączy się z serwerem autoryzacji i przetwarza autoryzację użytkownika.

Integracja z OpenID Connect

Aby zintegrować OpenID Connect przy użyciu DotNetOpenAuth .NET Core, można postępować zgodnie z poniższym podstawowym podejściem:

using DotNetOpenAuth.OAuth2;

// Configure the OpenID Connect client with authority details
var openIdClient = new WebServerClient(new AuthorizationServerDescription
{
    TokenEndpoint = new Uri("https://your-openid-provider.com/token"),
    AuthorizationEndpoint = new Uri("https://your-openid-provider.com/authorize")
}, "your-client-id");

// Redirect user for authentication
Uri authUri = openIdClient.GetAuthorizationRequestUri("openid email profile");
Response.Redirect(authUri.AbsoluteUri);

using DotNetOpenAuth.OAuth2;

// Configure the OpenID Connect client with authority details
var openIdClient = new WebServerClient(new AuthorizationServerDescription
{
    TokenEndpoint = new Uri("https://your-openid-provider.com/token"),
    AuthorizationEndpoint = new Uri("https://your-openid-provider.com/authorize")
}, "your-client-id");

// Redirect user for authentication
Uri authUri = openIdClient.GetAuthorizationRequestUri("openid email profile");
Response.Redirect(authUri.AbsoluteUri);

Imports DotNetOpenAuth.OAuth2

' Configure the OpenID Connect client with authority details
Private openIdClient = New WebServerClient(New AuthorizationServerDescription With {
	.TokenEndpoint = New Uri("https://your-openid-provider.com/token"),
	.AuthorizationEndpoint = New Uri("https://your-openid-provider.com/authorize")
}, "your-client-id")

' Redirect user for authentication
Private authUri As Uri = openIdClient.GetAuthorizationRequestUri("openid email profile")
Response.Redirect(authUri.AbsoluteUri)

Ten kod konfiguruje klienta OpenID Connect i przekierowuje użytkownika na stronę uwierzytelniania dostawcy OpenID.

Obsługa tokenów dostępu

Oto jak można obsługiwać tokeny dostępu za pomocą DotNetOpenAuth .NET Core:

// After the user is authenticated, process the authorization response to retrieve the token
IAuthorizationState authState = openIdClient.ProcessUserAuthorization();
if (authState != null && authState.IsAuthorized)
{
    // Access token is available, and you can use it to make authenticated requests
    string accessToken = authState.AccessToken;
}

// After the user is authenticated, process the authorization response to retrieve the token
IAuthorizationState authState = openIdClient.ProcessUserAuthorization();
if (authState != null && authState.IsAuthorized)
{
    // Access token is available, and you can use it to make authenticated requests
    string accessToken = authState.AccessToken;
}

' After the user is authenticated, process the authorization response to retrieve the token
Dim authState As IAuthorizationState = openIdClient.ProcessUserAuthorization()
If authState IsNot Nothing AndAlso authState.IsAuthorized Then
	' Access token is available, and you can use it to make authenticated requests
	Dim accessToken As String = authState.AccessToken
End If

Ten fragment kodu przetwarza odpowiedź dotyczącą autoryzacji użytkownika w celu pobrania i wykorzystania tokenu dostępu.

Odświeżanie tokenów

Aby odświeżyć tokeny po ich wygaśnięciu, użyj następującego kodu:

// Check if the access token is expired and refresh it
if (authState.AccessTokenExpirationUtc <= DateTime.UtcNow)
{
    if (openIdClient.RefreshAuthorization(authState))
    {
        // Token refreshed successfully
    }
}

// Check if the access token is expired and refresh it
if (authState.AccessTokenExpirationUtc <= DateTime.UtcNow)
{
    if (openIdClient.RefreshAuthorization(authState))
    {
        // Token refreshed successfully
    }
}

' Check if the access token is expired and refresh it
If authState.AccessTokenExpirationUtc <= DateTime.UtcNow Then
	If openIdClient.RefreshAuthorization(authState) Then
		' Token refreshed successfully
	End If
End If

Ten kod sprawdza, czy aktualny token wygasł, i próbuje go odświeżyć.

Cofanie tokenów

Jeśli chcesz unieważnić tokeny, zrób to tak, jak pokazano poniżej:

// Revoke the access token
bool success = openIdClient.RevokeAuthorization(authState);
if (success)
{
    // Token revoked successfully
}

// Revoke the access token
bool success = openIdClient.RevokeAuthorization(authState);
if (success)
{
    // Token revoked successfully
}

' Revoke the access token
Dim success As Boolean = openIdClient.RevokeAuthorization(authState)
If success Then
	' Token revoked successfully
End If

Ten fragment kodu cofa autoryzację, skutecznie unieważniając token dostępu.

Dostosowywanie żądań tokenów

Aby dostosować żądania tokenów do konkretnych potrzeb, np. dodając dodatkowe parametry:

// Customize the token request with additional parameters
var additionalParams = new Dictionary<string, string>
{
    {"custom_parameter", "value"}
};
IAuthorizationState customizedState = openIdClient.ProcessUserAuthorization(additionalParams);
if (customizedState != null && customizedState.IsAuthorized)
{
    // Token request customized and processed successfully
}

// Customize the token request with additional parameters
var additionalParams = new Dictionary<string, string>
{
    {"custom_parameter", "value"}
};
IAuthorizationState customizedState = openIdClient.ProcessUserAuthorization(additionalParams);
if (customizedState != null && customizedState.IsAuthorized)
{
    // Token request customized and processed successfully
}

' Customize the token request with additional parameters
Dim additionalParams = New Dictionary(Of String, String) From {
	{"custom_parameter", "value"}
}
Dim customizedState As IAuthorizationState = openIdClient.ProcessUserAuthorization(additionalParams)
If customizedState IsNot Nothing AndAlso customizedState.IsAuthorized Then
	' Token request customized and processed successfully
End If

Ten kod dodaje niestandardowe parametry do żądania tokenu, co może być przydatne przy spełnianiu konkretnych wymagań serwera autoryzacyjnego.

Przykład zastosowania połączenia IronPDF z DotNetOpenAuth .NET Core

Praktycznym przykładem zastosowania połączenia IronPDF z DotNetOpenAuth .NET Core jest aplikacja internetowa, w której uwierzytelnieni użytkownicy muszą generować i pobierać spersonalizowane raporty. Wyobraźmy sobie na przykład sytuację, w której użytkownicy logują się do aplikacji i uzyskują dostęp do swoich raportów finansowych w formacie PDF. DotNetOpenAuth zapewnia, że użytkownicy są prawidłowo uwierzytelniani i autoryzowani do dostępu do swoich dokumentów, podczas gdy IronPDF zajmuje się tworzeniem i dostarczaniem tych spersonalizowanych plików PDF.

Przykładowy kod przedstawiający przypadek użycia

Przyjrzyjmy się kompletnemu przykładowi kodu, który pokazuje, jak to zaimplementować. Stworzymy proste API internetowe w .NET Core, które uwierzytelnia użytkownika, a następnie generuje raport PDF przy użyciu IronPDF:

using IronPdf;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Authorization;

[Route("api/[controller]")]
[ApiController]
public class ReportController : ControllerBase
{
    [Authorize]
    [HttpGet("download-pdf")]
    public IActionResult DownloadPdfReport()
    {
        // Authentication is handled by DotNetOpenAuth .NET Core
        var currentUser = HttpContext.User.Identity.Name;

        // Generate PDF content using IronPDF
        var Renderer = new ChromePdfRenderer();
        var PDF = Renderer.RenderHtmlAsPdf($"<h1>Report for {currentUser}</h1><p>This is your personalized financial report.</p>");

        // Set file name and content type for the PDF
        var outputFileName = $"Report-{currentUser}.pdf";
        Response.Headers.Add("Content-Disposition", $"attachment; filename={outputFileName}");
        Response.ContentType = "application/pdf";

        // Return the generated PDF file
        return File(PDF.Stream.ToArray(), "application/pdf");
    }
}

using IronPdf;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Authorization;

[Route("api/[controller]")]
[ApiController]
public class ReportController : ControllerBase
{
    [Authorize]
    [HttpGet("download-pdf")]
    public IActionResult DownloadPdfReport()
    {
        // Authentication is handled by DotNetOpenAuth .NET Core
        var currentUser = HttpContext.User.Identity.Name;

        // Generate PDF content using IronPDF
        var Renderer = new ChromePdfRenderer();
        var PDF = Renderer.RenderHtmlAsPdf($"<h1>Report for {currentUser}</h1><p>This is your personalized financial report.</p>");

        // Set file name and content type for the PDF
        var outputFileName = $"Report-{currentUser}.pdf";
        Response.Headers.Add("Content-Disposition", $"attachment; filename={outputFileName}");
        Response.ContentType = "application/pdf";

        // Return the generated PDF file
        return File(PDF.Stream.ToArray(), "application/pdf");
    }
}

Imports IronPdf
Imports Microsoft.AspNetCore.Mvc
Imports Microsoft.AspNetCore.Authorization

<Route("api/[controller]")>
<ApiController>
Public Class ReportController
	Inherits ControllerBase

	<Authorize>
	<HttpGet("download-pdf")>
	Public Function DownloadPdfReport() As IActionResult
		' Authentication is handled by DotNetOpenAuth .NET Core
		Dim currentUser = HttpContext.User.Identity.Name

		' Generate PDF content using IronPDF
		Dim Renderer = New ChromePdfRenderer()
		Dim PDF = Renderer.RenderHtmlAsPdf($"<h1>Report for {currentUser}</h1><p>This is your personalized financial report.</p>")

		' Set file name and content type for the PDF
		Dim outputFileName = $"Report-{currentUser}.pdf"
		Response.Headers.Add("Content-Disposition", $"attachment; filename={outputFileName}")
		Response.ContentType = "application/pdf"

		' Return the generated PDF file
		Return File(PDF.Stream.ToArray(), "application/pdf")
	End Function
End Class

W tym przykładzie używamy atrybutu [Authorize], aby zapewnić, że tylko uwierzytelnieni użytkownicy mają dostęp do punktu końcowego generowania plików PDF. Klasa ChromePdfRenderer z biblioteki IronPDF służy do tworzenia plików PDF na podstawie treści HTML, które w tym przypadku są dynamicznie personalizowane imieniem użytkownika.