.NET 幫助

C# OAuth2(開發人員如何使用)

發佈 2024年3月6日
分享:

OAuth2 是一種強大的協議,用於通過處理用戶身份驗證和授權來保護您的Web應用程式。在C# 開發領域,了解OAuth2 可以大大提高您的應用程式的安全性和功能。

本指南適合初學者,重點介紹關鍵概念、實用範例和易於理解的解釋。我們還將學習一個使用OAuth2 的實際案例。 IronPDF 圖書館

了解 OAuth2 及其重要性

C# OAuth2(對開發人員的操作方式):圖1 - OAuth2網頁

OAuth2 是一種協議,允許客戶端應用程序代表用戶請求訪問由授權伺服器托管的資源。這是在現代網絡應用程序中處理用戶身份驗證和授權的常見方法。

OAuth2 的主要目標是提供安全且有效的資源訪問,而不共享用戶的憑證。 (如用戶名和密碼) 直接與客戶端應用程序通信。

OAuth2 主要概念

在深入實作之前,讓我們先釐清一些基本的 OAuth2 術語:

  • Client Application:請求訪問用戶帳戶的應用程序。
  • Authorization Server:驗證用戶並向客戶端應用程序發出訪問令牌的伺服器。
  • Access Token:允許客戶端應用程序在限定時間內訪問用戶帳戶的令牌。
  • Refresh Token:當當前的訪問令牌過期時,用於獲取新訪問令牌的令牌,而無需再次要求用戶憑證。
  • Client IDClient Secret:識別客戶端應用程序對授權伺服器的憑證。
  • Redirect URI:授權伺服器在授予或拒絕訪問客戶端應用程序後將用戶重定向的 URI。
  • Authorization Code Flow:一種安全的方法,其中客戶端應用程序先收到授權碼,然後再將其交換為訪問令牌。

在C#中實現OAuth2:基本範例

讓我們建立一個簡單的C#應用程式,使用OAuth2進行用戶驗證。本範例將引導您設定OAuth2客戶端、獲取訪問令牌,以及向受保護的資源發出請求。

設置您的 OAuth2 客戶端

首先,您需要在 OAuth2 授權伺服器上註冊您的 C# 應用程序。這個過程依伺服器而變,但通常您會收到一個客戶端 ID 和一個客戶端密鑰,這對於 OAuth2 流程至關重要。

第一步:定義應用程式的憑證

作為第一步,設置您的客戶端憑證,例如客戶端 ID 和客戶端 Secret。以下是範例程式碼:

class Program
{
    private static string clientId = "your-client-id";
    private static string clientSecret = "your-client-secret";
    private static string redirectUri = "your-redirect-uri";
    static void Main(string [] args)
    {
        // OAuth2 implementation will go here
    }
}
class Program
{
    private static string clientId = "your-client-id";
    private static string clientSecret = "your-client-secret";
    private static string redirectUri = "your-redirect-uri";
    static void Main(string [] args)
    {
        // OAuth2 implementation will go here
    }
}
Friend Class Program
	Private Shared clientId As String = "your-client-id"
	Private Shared clientSecret As String = "your-client-secret"
	Private Shared redirectUri As String = "your-redirect-uri"
	Shared Sub Main(ByVal args() As String)
		' OAuth2 implementation will go here
	End Sub
End Class
VB   C#

第2步:請求使用者授權

要啟動OAuth2流程,將使用者重定向至授權伺服器的授權端點。以下是構建授權請求URL的方法:

static void Main(string [] args)
{
    var authorizationEndpoint = "https://authorization-server.com/auth";
    var responseType = "code";
    var scope = "email profile";
    var authorizationUrl = $"{authorizationEndpoint}?response_type={responseType}&client_id={clientId}&redirect_uri={redirectUri}&scope={scope}";
    // Redirect the user to authorizationUrl
}
static void Main(string [] args)
{
    var authorizationEndpoint = "https://authorization-server.com/auth";
    var responseType = "code";
    var scope = "email profile";
    var authorizationUrl = $"{authorizationEndpoint}?response_type={responseType}&client_id={clientId}&redirect_uri={redirectUri}&scope={scope}";
    // Redirect the user to authorizationUrl
}
Shared Sub Main(ByVal args() As String)
	Dim authorizationEndpoint = "https://authorization-server.com/auth"
	Dim responseType = "code"
	Dim scope = "email profile"
	Dim authorizationUrl = $"{authorizationEndpoint}?response_type={responseType}&client_id={clientId}&redirect_uri={redirectUri}&scope={scope}"
	' Redirect the user to authorizationUrl
End Sub
VB   C#

第三步:處理授權回應

在用戶授權或拒絕許可後,授權伺服器會將他們重定向回您的應用程式,並附上授權代碼或錯誤訊息。您需要從重定向 URI 的查詢參數中捕獲這個代碼。

步驟 4:兌換授權碼

現在,您將授權碼兌換為存取權杖。這需要向授權伺服器的令牌端點發送一個POST請求。

public static async Task<string> ExchangeAuthorizationCodeForAccessToken(string authorizationCode)
{
    var tokenEndpoint = "https://authorization-server.com/token";
    var postData = $"grant_type=authorization_code&code={authorizationCode}&redirect_uri={redirectUri}&client_id={clientId}&client_secret={clientSecret}";
    var data = Encoding.ASCII.GetBytes(postData);
    var request = WebRequest.Create(tokenEndpoint);
    request.Method = "POST";
    request.ContentType = "application/x-www-form-urlencoded";
    request.ContentLength = data.Length;
    using (var stream = request.GetRequestStream())
    {
        stream.Write(data, 0, data.Length);
    }
    var response = (HttpWebResponse)request.GetResponse();
    var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
    // Extract the access token from the response
    var token = ExtractAccessTokenFromResponse(responseString);
    return token;
}
public static async Task<string> ExchangeAuthorizationCodeForAccessToken(string authorizationCode)
{
    var tokenEndpoint = "https://authorization-server.com/token";
    var postData = $"grant_type=authorization_code&code={authorizationCode}&redirect_uri={redirectUri}&client_id={clientId}&client_secret={clientSecret}";
    var data = Encoding.ASCII.GetBytes(postData);
    var request = WebRequest.Create(tokenEndpoint);
    request.Method = "POST";
    request.ContentType = "application/x-www-form-urlencoded";
    request.ContentLength = data.Length;
    using (var stream = request.GetRequestStream())
    {
        stream.Write(data, 0, data.Length);
    }
    var response = (HttpWebResponse)request.GetResponse();
    var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
    // Extract the access token from the response
    var token = ExtractAccessTokenFromResponse(responseString);
    return token;
}
Public Shared Async Function ExchangeAuthorizationCodeForAccessToken(ByVal authorizationCode As String) As Task(Of String)
	Dim tokenEndpoint = "https://authorization-server.com/token"
	Dim postData = $"grant_type=authorization_code&code={authorizationCode}&redirect_uri={redirectUri}&client_id={clientId}&client_secret={clientSecret}"
	Dim data = Encoding.ASCII.GetBytes(postData)
	Dim request = WebRequest.Create(tokenEndpoint)
	request.Method = "POST"
	request.ContentType = "application/x-www-form-urlencoded"
	request.ContentLength = data.Length
	Using stream = request.GetRequestStream()
		stream.Write(data, 0, data.Length)
	End Using
	Dim response = CType(request.GetResponse(), HttpWebResponse)
	Dim responseString = (New StreamReader(response.GetResponseStream())).ReadToEnd()
	' Extract the access token from the response
	Dim token = ExtractAccessTokenFromResponse(responseString)
	Return token
End Function
VB   C#

此函式向令牌端點發送包含必要數據的POST請求,並返回從響應中提取的存取令牌。

第五步:進行授權請求

有了存取權杖,您現在可以向需要身份驗證的資源發出請求。將存取權杖附加到您請求的授權標頭中作為Bearer令牌。

public static async Task<string> MakeAuthorizedRequest(string accessToken, string apiUrl)
{
    var request = WebRequest.Create(apiUrl);
    request.Headers.Add("Authorization", $"Bearer {accessToken}");
    var response = (HttpWebResponse)request.GetResponse();
    var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
    return responseString;
}
public static async Task<string> MakeAuthorizedRequest(string accessToken, string apiUrl)
{
    var request = WebRequest.Create(apiUrl);
    request.Headers.Add("Authorization", $"Bearer {accessToken}");
    var response = (HttpWebResponse)request.GetResponse();
    var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
    return responseString;
}
Public Shared Async Function MakeAuthorizedRequest(ByVal accessToken As String, ByVal apiUrl As String) As Task(Of String)
	Dim request = WebRequest.Create(apiUrl)
	request.Headers.Add("Authorization", $"Bearer {accessToken}")
	Dim response = CType(request.GetResponse(), HttpWebResponse)
	Dim responseString = (New StreamReader(response.GetResponseStream())).ReadToEnd()
	Return responseString
End Function
VB   C#

IronPDF 介紹

C# OAuth2(開發人員如何使用):圖2 - IronPDF 網頁

IronPDF 是一個多功能的庫,適用於C#開發人員,使其能在 .NET 應用程式中直接生成、操作和渲染 PDF 文件。這個強大的工具簡化了 PDF 文件的處理,使創建複雜的文件變得輕而易舉, 將 HTML 轉換為 PDF,從 PDF 中提取文字,等等。它簡單明瞭的 API 讓開發者能夠快速在他們的應用程式中整合 PDF 功能,而不需要深厚的 PDF 規範知識。

IronPDF 擅長在 HTML 轉 PDF 轉換,保持佈局和樣式不變。此功能允許從網頁內容生成PDF,適用於報告、發票和文檔。它支援將HTML文件、URL和HTML字串轉換為PDF。

using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}
using IronPdf;

class Program
{
    static void Main(string[] args)
    {
        var renderer = new ChromePdfRenderer();

        // 1. Convert HTML String to PDF
        var htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>";
        var pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent);
        pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf");

        // 2. Convert HTML File to PDF
        var htmlFilePath = "path_to_your_html_file.html"; // Specify the path to your HTML file
        var pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath);
        pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf");

        // 3. Convert URL to PDF
        var url = "http://ironpdf.com"; // Specify the URL
        var pdfFromUrl = renderer.RenderUrlAsPdf(url);
        pdfFromUrl.SaveAs("URLToPDF.pdf");
    }
}
Imports IronPdf

Friend Class Program
	Shared Sub Main(ByVal args() As String)
		Dim renderer = New ChromePdfRenderer()

		' 1. Convert HTML String to PDF
		Dim htmlContent = "<h1>Hello, IronPDF!</h1><p>This is a PDF from an HTML string.</p>"
		Dim pdfFromHtmlString = renderer.RenderHtmlAsPdf(htmlContent)
		pdfFromHtmlString.SaveAs("HTMLStringToPDF.pdf")

		' 2. Convert HTML File to PDF
		Dim htmlFilePath = "path_to_your_html_file.html" ' Specify the path to your HTML file
		Dim pdfFromHtmlFile = renderer.RenderHtmlFileAsPdf(htmlFilePath)
		pdfFromHtmlFile.SaveAs("HTMLFileToPDF.pdf")

		' 3. Convert URL to PDF
		Dim url = "http://ironpdf.com" ' Specify the URL
		Dim pdfFromUrl = renderer.RenderUrlAsPdf(url)
		pdfFromUrl.SaveAs("URLToPDF.pdf")
	End Sub
End Class
VB   C#

代碼範例:從受保護的內容生成 PDF

想像一下,您有一個只允許經過身份驗證的用戶訪問的返回 HTML 內容的端點。您可以使用 IronPDF 將此 HTML 內容轉換為 PDF 文件,利用通過 OAuth2 獲得的訪問令牌。

首先,讓我們定義一個使用訪問令牌來獲取受保護的 HTML 內容的方法:

public static async Task<string> FetchProtectedContent(string accessToken, string apiUrl)
{
    var httpClient = new HttpClient();
    httpClient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", accessToken);
    var response = await httpClient.GetAsync(apiUrl);
    response.EnsureSuccessStatusCode();
    return await response.Content.ReadAsStringAsync();
}
public static async Task<string> FetchProtectedContent(string accessToken, string apiUrl)
{
    var httpClient = new HttpClient();
    httpClient.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", accessToken);
    var response = await httpClient.GetAsync(apiUrl);
    response.EnsureSuccessStatusCode();
    return await response.Content.ReadAsStringAsync();
}
Public Shared Async Function FetchProtectedContent(ByVal accessToken As String, ByVal apiUrl As String) As Task(Of String)
	Dim httpClient As New HttpClient()
	httpClient.DefaultRequestHeaders.Authorization = New System.Net.Http.Headers.AuthenticationHeaderValue("Bearer", accessToken)
	Dim response = Await httpClient.GetAsync(apiUrl)
	response.EnsureSuccessStatusCode()
	Return Await response.Content.ReadAsStringAsync()
End Function
VB   C#

現在讓我們使用IronPDF將獲取的HTML內容轉換為PDF文件:

public static async Task ConvertHtmlToPdf(string accessToken, string apiUrl, string outputPdfPath)
{
    // Fetch protected content using the access token
    string htmlContent = await FetchProtectedContent(accessToken, apiUrl);
    // Use IronPDF to convert the HTML content to a PDF document
    var renderer = new IronPdf.HtmlToPdf();
    var pdf = renderer.RenderHtmlAsPdf(htmlContent);
    // Save the generated PDF to a file
    pdf.SaveAs(outputPdfPath);
}
public static async Task ConvertHtmlToPdf(string accessToken, string apiUrl, string outputPdfPath)
{
    // Fetch protected content using the access token
    string htmlContent = await FetchProtectedContent(accessToken, apiUrl);
    // Use IronPDF to convert the HTML content to a PDF document
    var renderer = new IronPdf.HtmlToPdf();
    var pdf = renderer.RenderHtmlAsPdf(htmlContent);
    // Save the generated PDF to a file
    pdf.SaveAs(outputPdfPath);
}
Public Shared Async Function ConvertHtmlToPdf(ByVal accessToken As String, ByVal apiUrl As String, ByVal outputPdfPath As String) As Task
	' Fetch protected content using the access token
	Dim htmlContent As String = Await FetchProtectedContent(accessToken, apiUrl)
	' Use IronPDF to convert the HTML content to a PDF document
	Dim renderer = New IronPdf.HtmlToPdf()
	Dim pdf = renderer.RenderHtmlAsPdf(htmlContent)
	' Save the generated PDF to a file
	pdf.SaveAs(outputPdfPath)
End Function
VB   C#

在上述代码中,FetchProtectedContent 負責使用 OAuth2 訪問令牌從保護的資源檢索 HTML 內容。一旦獲取到 HTML 內容,它會被傳遞給 IronPDF 的 HtmlToPdf 渲染器來生成 PDF 文檔,然後將其保存到指定路徑。

結論

C# OAuth2(開發人員如何使用):圖 3 - IronPDF 許可頁面

本指南介紹了在C#應用程式中使用OAuth2的基本知識,涵蓋了關鍵概念、術語和一個簡單實施範例。OAuth2在通過有效處理用戶認證和授權來保護網路應用程式方面起著至關重要的作用。儘管這個範例展示了授權碼流程,OAuth2還支援其他適合不同類型應用程式的流程。

通过整合 IronPDFC# 開發人員可以擴展其應用程式的功能,包含 PDF 生成和操作,從而豐富認證用戶可用的功能。IronPDF 的易用性和全面的 PDF 操作能力使其成為 .NET 開發人員在項目中處理 PDF 文件的絕佳工具。 它提供了一個 免費試用 測試所有功能。其授權從 $liteLicense 開始。

< 上一頁
C# WebRTC(開發人員如何運作)
下一個 >
C# 運算符(如何對開發者起作用)

準備開始了嗎? 版本: 2024.10 剛剛發布

免費 NuGet 下載 總下載次數: 10,993,239 查看許可證 >