Add EncryptPdf example and README section

Jaben · Jaben · commit 9724fa7a468a · 2026-03-28T12:10:49.000-04:00
Add console example demonstrating PDF encryption with user/owner
passwords. Add corresponding README section.
diff --git a/README.md b/README.md
@@ -461,6 +461,23 @@ public async Task<Stream> ConvertToAccessiblePdfA(string pdfPath)
 }
 ```
 
+### PDF Encryption
+*Password-protect PDFs with user and owner passwords:*
+
+```csharp
+public async Task<Stream> CreateEncryptedPdf()
+{
+    var builder = new HtmlRequestBuilder()
+        .AddDocument(doc => doc.SetBody("<html><body><h1>Confidential</h1></body></html>"))
+        .SetPdfOutputOptions(o => o
+            .SetEncryption(userPassword: "reader123", ownerPassword: "admin456"))
+        .WithPageProperties(pp => pp.UseChromeDefaults());
+
+    var request = builder.Build();
+    return await _sharpClient.HtmlToPdfAsync(request);
+}
+```
+
 ### Flatten PDFs
 *Flatten PDF forms and annotations (v2.8+):*
 
diff --git a/examples/EncryptPdf/EncryptPdf.csproj b/examples/EncryptPdf/EncryptPdf.csproj
@@ -0,0 +1,2 @@
+<Project Sdk="Microsoft.NET.Sdk">
+</Project>
diff --git a/examples/EncryptPdf/Program.cs b/examples/EncryptPdf/Program.cs
@@ -0,0 +1,60 @@
+using Gotenberg.Sharp.API.Client;
+using Gotenberg.Sharp.API.Client.Domain.Builders;
+using Gotenberg.Sharp.API.Client.Domain.Settings;
+using Gotenberg.Sharp.API.Client.Infrastructure.Pipeline;
+
+using Microsoft.Extensions.Configuration;
+
+var config = new ConfigurationBuilder()
+    .SetBasePath(AppContext.BaseDirectory)
+    .AddJsonFile("appsettings.json")
+    .Build();
+
+var options = new GotenbergSharpClientOptions();
+config.GetSection(nameof(GotenbergSharpClient)).Bind(options);
+
+var destinationDirectory = args.Length > 0 ? args[0] : Path.Combine(Directory.GetCurrentDirectory(), "output");
+Directory.CreateDirectory(destinationDirectory);
+
+var path = await CreateEncryptedPdf(destinationDirectory, options);
+Console.WriteLine($"Encrypted PDF created: {path}");
+Console.WriteLine("Open with password: reader123");
+
+static async Task<string> CreateEncryptedPdf(string destinationDirectory, GotenbergSharpClientOptions options)
+{
+    using var handler = new HttpClientHandler();
+    using var authHandler = !string.IsNullOrWhiteSpace(options.BasicAuthUsername) && !string.IsNullOrWhiteSpace(options.BasicAuthPassword)
+        ? new BasicAuthHandler(options.BasicAuthUsername, options.BasicAuthPassword) { InnerHandler = handler }
+        : null;
+
+    using var httpClient = new HttpClient(authHandler ?? (HttpMessageHandler)handler)
+    {
+        BaseAddress = options.ServiceUrl,
+        Timeout = options.TimeOut
+    };
+
+    var sharpClient = new GotenbergSharpClient(httpClient);
+
+    // Create a password-protected PDF
+    var builder = new HtmlRequestBuilder()
+        .AddDocument(doc => doc.SetBody(@"
+            <html><body>
+                <h1>Confidential Report</h1>
+                <p>This document is password protected.</p>
+            </body></html>"))
+        .SetPdfOutputOptions(o => o
+            .SetEncryption(
+                userPassword: "reader123",     // Required to open the PDF
+                ownerPassword: "admin456"))    // Required to change permissions
+        .WithPageProperties(pp => pp.UseChromeDefaults());
+
+    var request = builder.Build();
+    var response = await sharpClient.HtmlToPdfAsync(request);
+
+    var resultPath = Path.Combine(destinationDirectory, $"Encrypted-{DateTime.Now:yyyyMMddHHmmss}.pdf");
+
+    await using var destinationStream = File.Create(resultPath);
+    await response.CopyToAsync(destinationStream, CancellationToken.None);
+
+    return resultPath;
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+<Project Sdk="Microsoft.NET.Sdk">`
	`2`	`+</Project>`