.NET 幫助

Dotnetopenauth .NET Core（它如何為開發人員工作）

喬迪·巴迪亞

2024年7月1日

DotNetOpenAuth .NET Core 是原始 DotNetOpenAuth 庫的 .NET Core 版本，提供穩健的公共 API。此程式庫幫助您將 OAuth2 和 OpenID 驗證新增至您的 .NET 應用程式中。 IronPDF 是一個用於在 .NET 中創建、閱讀和編輯 PDF 文件的庫。這對於直接從您的 .NET 應用程式生成諸如報告和發票等文件非常有用。

您可以在各類專案中使用 DotNetOpenAuth .NET Core 和 IronPDF，如網頁和桌面應用程式，以利用共用的程式碼並實現新功能。它們對於希望在其軟體中處理身份驗證和 PDF 文件管理的開發人員來說是必不可少的。

開始使用DotNetOpenAuth .NET Core

在 .NET 專案中設置 DotNetOpenAuth .NET Core

要在您的 .NET 專案中開始使用由微軟技術支援的 DotNetOpenAuth .NET Core，請遵循以下步驟：

在 Visual Studio 中打開您的專案。
前往方案總管。
右鍵點擊您的專案名稱。
選擇 管理 NuGet 套件。
在 NuGet 套件管理器中，搜索 DotNetOpenAuth.NetCore 和其他 NuGet 套件。
按 Install 將其添加到您的專案中。
這將把 DotNetOpenAuth .NET Core 庫添加到您的項目中，提供整合身份驗證功能的支持。

使用 DotNetOpenAuth .NET Core 的基本代碼範例

以下是一個簡單的範例，說明如何在您的應用程式中使用 DotNetOpenAuth .NET Core 設定 OAuth2 認證：

using DotNetOpenAuth.OAuth2;

// Initialize the OAuth2 client
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
IAuthorizationState state = client.ProcessUserAuthorization();
if (state != null && state.IsAuthorized)
{
    // Authorized successfully, now you can access protected resources
}

using DotNetOpenAuth.OAuth2;

// Initialize the OAuth2 client
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
IAuthorizationState state = client.ProcessUserAuthorization();
if (state != null && state.IsAuthorized)
{
    // Authorized successfully, now you can access protected resources
}

Imports DotNetOpenAuth.OAuth2

' Initialize the OAuth2 client
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
Private state As IAuthorizationState = client.ProcessUserAuthorization()
If state IsNot Nothing AndAlso state.IsAuthorized Then
	' Authorized successfully, now you can access protected resources
End If

以下代碼片段使用 DotNetOpenAuth .NET Core 設置 OAuth2 客戶端，連接到授權伺服器並處理用戶授權。

在 .NET Core 中實現 DotNetOpenAuth 功能

整合 OpenID Connect

若要使用 DotNetOpenAuth .NET Core 整合 OpenID Connect，您可以遵循以下基本方法：

using DotNetOpenAuth.OAuth2;

// Configure the OpenID Connect client
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
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
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)

此代碼配置一個OpenID Connect客戶端，並將使用者重定向至OpenID提供者的身份驗證頁面。

處理存取權杖

以下是利用 DotNetOpenAuth .NET Core 處理存取權杖的方法：

// After user is authenticated, process the authorization response
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 user is authenticated, process the authorization response
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 user is authenticated, process the authorization response
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

此程式碼片段處理使用者授權回應來檢索並使用訪問令牌。

刷新令牌

要在權杖過期時更新權杖，請使用以下代碼：

// 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

此代碼檢查當前令牌是否已過期並嘗試刷新它。

撤銷令牌

如果您需要撤銷令牌，請按如下所示實施：

// 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

此程式碼片段撤銷了授權，有效地使存取權杖無效。

自訂令牌請求

要根據具體需求自訂令牌請求，例如添加額外的參數：

// Customize the token request
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
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
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

此程式碼將自訂參數添加到令牌請求中，這對於處理授權伺服器的特定需求可能很有用。

DotNetOpenAuth .NET Core 與 IronPDF

IronPDF 是一個全面的程式庫，允許開發者在 .NET 環境中創建、讀取和操作 PDF 文件。它特別適用於從 HTML 或直接從 URL 生成 PDF，這對於製作報告、生成發票或以靜態格式存儲網頁來說非常有用。當與 DotNetOpenAuth .NET Core 整合時，它確保這些功能是安全的，且僅限於經過身份驗證的用戶訪問。

將 IronPDF 與 DotNetOpenAuth .NET Core 合併的用例

將 IronPDF 與 DotNetOpenAuth .NET Core 合併的一個實際用例是在一個網頁應用程式中，經過身份驗證的用戶需要生成並下載個性化報告。例如，想像一個場景，使用者登入您的應用程式並以 PDF 格式存取他們的財務報告。 DotNetOpenAuth 確保用戶獲得適當的身份驗證和授權以訪問他們的文件，而 IronPDF 負責創建和交付這些個性化的 PDF。

使用案例的程式碼範例

讓我們來看看一個完整的代碼範例，演示如何實施這個功能。我們將在 .NET Core 中創建一個簡單的網路 API 來驗證使用者身份，然後使用 IronPDF 生成 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");
    }
}

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

在此示例中，我們使用 [授權]屬性，以確保只有經過身份驗證的用戶才能訪問 PDF 生成端點。 IronPDF的ChromePdfRenderer類別用於從HTML內容創建PDF，在這種情況下，HTML內容會根據使用者的名字進行動態個性化定制。

DotNetOpenAuth .NET Core（開發人員運作過程）：圖 1

結論

將 DotNetOpenAuth .NET Core 與 IronPDF 整合，為增強 .NET 應用程式的安全性和功能性提供了一個強大的解決方案。透過利用這些技術，您可以有效保護敏感資料，並透過動態 PDF 生成提供個性化的用戶體驗。

IronPDF 不僅多才多藝，而且對開發人員友好，提供了一種簡單的方法來在 .NET 應用程式中創建和管理 PDF 檔案。如果您正在考慮將 IronPDF 納入您的項目，建議探索IronPDF 官方網站免費試用和授權選項。

喬迪·巴迪亞

立即與工程團隊聊天

軟體工程師

Jordi 最擅長 Python、C# 和 C++，當他不在 Iron Software 發揮技能時，他會進行遊戲編程。他負責產品測試、產品開發和研究，為持續產品改進增添了巨大的價值。多樣化的經驗使他感到挑戰和投入，他說這是與 Iron Software 合作的最喜歡的方面之一。Jordi 在佛羅里達州邁阿密長大，並在佛羅里達大學學習計算機科學和統計學。

< 上一頁
Specflow C#（開發人員工作原理）

下一個 >
OpenTelemetry .NET（對開發人員的運作方式）