How to use IronSecureDoc from C# in .NET

This article was translated from English: Does it need improvement?
Translated
View the article in English

增強文件安全的入口

IronSoftware.SecureDoc.Client 是一個強大的客戶端程式庫,設計成能夠無縫地與 IronSecureDoc API 互動,這是一個在 Docker 容器中運行的全面文件安全解決方案。

這個客戶端程式庫簡化了與您現有的 .NET 應用程式的整合,使您可以通過簡單的 REST API 呼叫,利用 IronSecureDoc 的強大功能,包括PDF加密、減少及數位簽名。

透過 IronSoftware.SecureDoc.Client,開發者可以確保應用程式內文件的安全和完整性,並將所有操作保持在本地以增強資料保護。 無論您需要減少敏感資訊、用數位簽名認證文件,還是強制執行文件加密,IronSoftware.SecureDoc.Client 提供了必要的工具來高效且安全地完成這些任務。

功能

主要功能:

  • IronSecureDoc 的 REST API 簡單整合。
  • 支援文件加密、減少及數位簽名。
  • 促進自託管環境中的安全文件處理。
  • 通過在本地保持文件安全操作來增強資料保護。
  • 與 .NET 應用程式相容,提供一個直接的安全文件管理方法。

安裝

讓我們從套件管理器中安裝 NuGet 套件開始:

選項 1:從 NuGet 下載

NuGet 套件已列在官方 NuGet 網站上: https://www.nuget.org/packages/IronSoftware.SecureDoc.Client

選項 2:PM 安裝指令

Install-Package IronSoftware.SecureDoc.Client

程式碼範例

using IronSecureDoc;
using System.IO;
using System.Threading.Tasks;

// Example illustrating how to use the IronSecureDocClient
class SecureDocExample
{
    static async Task Main(string[] args)
    {
        // Replace with your IRONSECUREDOC URL
        var client = new IronSecureDocClient("http://localhost:5185");

        // Replace with your PDF or CERT paths
        string PDF_PATH = "path/to/your.pdf";
        string CERT_PATH = "path/to/your.p12";

        // Attempt to connect to the IronSecureDoc API
        if (await client.TryConnectAsync())
        {
            // Redact Text
            File.WriteAllBytes(
                "redact_text_example.pdf",
                await client.RedactTextAsync(PDF_PATH, new[] { "Dummy" })
            );

            // Redact Region
            File.WriteAllBytes(
                "redact_region_example.pdf",
                await client.RedactRegionAsync(PDF_PATH, 50, 50, 200, 100)
            );

            // Certify
            File.WriteAllBytes(
                "certify_example.pdf",
                await client.CertifyAsync(PDF_PATH, CERT_PATH, "123456", CertifyPermissions.FormFillingAllowed)
            );

            // Encrypt
            File.WriteAllBytes(
                "encrypt_example.pdf",
                await client.EncryptAsync(PDF_PATH, "iron")
            );
        }
    }
}
using IronSecureDoc;
using System.IO;
using System.Threading.Tasks;

// Example illustrating how to use the IronSecureDocClient
class SecureDocExample
{
    static async Task Main(string[] args)
    {
        // Replace with your IRONSECUREDOC URL
        var client = new IronSecureDocClient("http://localhost:5185");

        // Replace with your PDF or CERT paths
        string PDF_PATH = "path/to/your.pdf";
        string CERT_PATH = "path/to/your.p12";

        // Attempt to connect to the IronSecureDoc API
        if (await client.TryConnectAsync())
        {
            // Redact Text
            File.WriteAllBytes(
                "redact_text_example.pdf",
                await client.RedactTextAsync(PDF_PATH, new[] { "Dummy" })
            );

            // Redact Region
            File.WriteAllBytes(
                "redact_region_example.pdf",
                await client.RedactRegionAsync(PDF_PATH, 50, 50, 200, 100)
            );

            // Certify
            File.WriteAllBytes(
                "certify_example.pdf",
                await client.CertifyAsync(PDF_PATH, CERT_PATH, "123456", CertifyPermissions.FormFillingAllowed)
            );

            // Encrypt
            File.WriteAllBytes(
                "encrypt_example.pdf",
                await client.EncryptAsync(PDF_PATH, "iron")
            );
        }
    }
}
Imports IronSecureDoc
Imports System.IO
Imports System.Threading.Tasks

' Example illustrating how to use the IronSecureDocClient
Friend Class SecureDocExample
	Shared Async Function Main(ByVal args() As String) As Task
		' Replace with your IRONSECUREDOC URL
		Dim client = New IronSecureDocClient("http://localhost:5185")

		' Replace with your PDF or CERT paths
		Dim PDF_PATH As String = "path/to/your.pdf"
		Dim CERT_PATH As String = "path/to/your.p12"

		' Attempt to connect to the IronSecureDoc API
		If Await client.TryConnectAsync() Then
			' Redact Text
			File.WriteAllBytes("redact_text_example.pdf", Await client.RedactTextAsync(PDF_PATH, { "Dummy" }))

			' Redact Region
			File.WriteAllBytes("redact_region_example.pdf", Await client.RedactRegionAsync(PDF_PATH, 50, 50, 200, 100))

			' Certify
			File.WriteAllBytes("certify_example.pdf", Await client.CertifyAsync(PDF_PATH, CERT_PATH, "123456", CertifyPermissions.FormFillingAllowed))

			' Encrypt
			File.WriteAllBytes("encrypt_example.pdf", Await client.EncryptAsync(PDF_PATH, "iron"))
		End If
	End Function
End Class
$vbLabelText   $csharpLabel

IronSecureDocClient

說明

  • IronSecureDocClient 初始化:使用您的 IRONSECUREDOC 伺服器的 URL 初始化 IronSecureDocClient
  • 連接:使用 TryConnectAsync() 驗證與伺服器的連接。
  • 減少文字:使用 RedactTextAsync 定義敏感詞/短語以進行減少。
  • 減少區域:通過使用 RedactRegionAsync 指定座標來減少特定區域。
  • 證明:使用 CertifyAsync 新增數位證書。 提供認證文件的路徑和密碼。
  • 加密:使用 EncryptAsync 加密文件來確保安全。

支援

如需支援,請聯絡我們:support@ironsoftware.com

常見問題

如何將文件安全功能整合到我的.NET應用程式中?

您可以使用IronSoftware.SecureDoc.Client程式庫整合文件安全功能。這允許您通過REST API呼叫執行PDF加密、修訂和數位簽名等操作。

安裝C#專案中的IronSecureDoc客戶端涉及哪些步驟?

要在C#專案中安裝IronSecureDoc客戶端,您可以從NuGet下載IronSoftware.SecureDoc.Client套件或使用Package Manager命令:Install-Package IronSoftware.SecureDoc.Client

我可以使用此解決方案在PDF文件中執行文字修訂嗎?

是的,您可以使用RedactTextAsync方法執行PDF文件中的文字修訂,這允許您指定要修訂的詞語或短語。

如何確保我的文件操作保持安全並在內部進行?

使用IronSecureDoc將文件操作保持安全並在內部進行方法是通過整合IronSecureDoc API(Docker託管的解決方案),確保所有安全流程都在本地處理。

IronSecureDoc API在文件管理方面提供了什麼功能?

IronSecureDoc API提供功能如文件加密、修訂、數位簽名,並促進自我託管環境中的安全文件處理。

我如何使用數位簽名認證PDF文件?

要使用數位簽名認證PDF文件,使用CertifyAsync方法,提供您的認證文件路徑和必要的密碼。

我如何在C#應用中加密PDF文件?

您可以在C#應用中使用EncryptAsync方法加密PDF文件,該方法使用指定的密碼來保障文件安全。

是否可以修訂PDF文件中的特定區域?

是的,可以使用RedactRegionAsync方法修訂PDF文件中的特定區域,該方法需要您指定欲修訂區域的座標。

如果使用IronSecureDoc客戶端時遇到問題,我該怎麼辦?

如果使用IronSecureDoc客戶端時遇到問題,您可以通過電子郵件支援support@ironsoftware.com聯繫IronSoftware的支援團隊以獲得協助。

Curtis Chau
技術作家

Curtis Chau擁有Carleton大學的電腦科學學士學位,專精於前端開發,擁有Node.js、TypeScript、JavaScript和React的專業知識。Curtis熱衷於建立直觀且美觀的使用者介面,喜愛使用現代框架並建立結構良好、視覺吸引力的手冊。

除了開發,Curtis對物聯網(IoT)有濃厚的興趣,探索創新的方法來整合硬體和軟體。在空閒時間,他喜歡玩遊戲和建立Discord機器人,結合他對技術的熱愛與創造力。

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

還在滾動嗎?

想要快速證明嗎?
運行一個樣本觀看您的PDF加密。