Datovka 1.0.5

<div align="center">

<img width="512" alt="Datová schránka" src="https://github.com/user-attachments/assets/58936c00-2994-47c9-97be-4404fa64c701" />

Datovka

A netstandard 2.0 library for communicating with the Czech Data Box (ISDS - Informační systém datových schránek).

<a href="https://www.scio.cz/prace-u-nas" target="_blank"> <figure> <img alt="Scio" width="256" src="/DatovkaSharp/scio.svg" /> </figure> </a>

Sponsored by Scio </div>

✨ Features

• Full support for Czech Data Box API (v3.0.9)
• Multiple authentication methods:
  • Username/Password
  • Certificate-based (Spisová služba - SS mode)
  • Certificate + DataBox ID (Hostovaná spisová služba - HSS mode)
  • Support for certificates from file, byte array, stream, or X509Certificate2 object
  • Customizable X509 key storage flags
• Test and Production environment support
• Send and receive messages with attachments
• Download signed messages (ZFO format)
• Search for data boxes
• Password management (OTP-based password change, get password info)
• Mark messages as read
• Message archiving (ArchiveISDSDocument)
• DataBox administration (create, delete, update databoxes and users)
• Draft/concept management (ExtIS2 integration)
• Credit information and usage tracking

⚡ Installation

NuGet

dotnet add package Datovka

From Source

git clone https://github.com/yourusername/DatovkaSharp.git
cd DatovkaSharp
dotnet build

🪄 Quick Start

Authentication with Username and Password

using DatovkaSharp;

// Create client for test environment
var client = new DatovkaClient(DataBoxEnvironment.Test);

// Login
client.LoginWithUsernameAndPassword("your-username", "your-password");

// Access API
var api = client.Api;

Authentication with Certificate

DatovkaSharp supports two certificate-based authentication modes for system integration:

Spisová služba (Filing Service - SS mode)

System certificate authentication without username:

var client = new DatovkaClient(DataBoxEnvironment.Production);

// From file
client.LoginWithCertificate("path/to/certificate.pfx", "certificate-password");

// From byte array
byte[] certBytes = File.ReadAllBytes("certificate.pfx");
client.LoginWithCertificate(certBytes, "certificate-password");

// From stream
using var stream = File.OpenRead("certificate.pfx");
client.LoginWithCertificate(stream, "certificate-password");

Hostovaná spisová služba (Hosted Filing Service - HSS mode)

System certificate + DataBox ID authentication for external applications:

var client = new DatovkaClient(DataBoxEnvironment.Production);
string dataBoxId = "abc123"; // Target data box ID

// From file
client.LoginWithCertificateAndDataBoxId("path/to/certificate.pfx", dataBoxId, "certificate-password");

// From byte array
byte[] certBytes = File.ReadAllBytes("certificate.pfx");
client.LoginWithCertificateAndDataBoxId(certBytes, dataBoxId, "certificate-password");

// From stream
using var stream = File.OpenRead("certificate.pfx");
client.LoginWithCertificateAndDataBoxId(stream, dataBoxId, "certificate-password");

Note: HSS mode is designed for external applications (like hosted filing systems) that need to access specific data boxes on behalf of their owners.

Advanced: Customizing Certificate Storage Flags

By default, certificates are loaded with MachineKeySet | PersistKeySet | Exportable flags. You can customize these:

// Custom storage flags for specific security requirements
var customFlags = X509KeyStorageFlags.UserKeySet | X509KeyStorageFlags.Exportable;
client.LoginWithCertificate("path/to/cert.pfx", "password", customFlags);

// Also works with HSS mode
client.LoginWithCertificateAndDataBoxId("path/to/cert.pfx", dataBoxId, "password", customFlags);

Using X509Certificate2 Objects Directly

You can also provide a pre-loaded certificate object:

// Load certificate with custom flags
var cert = new X509Certificate2("path/to/cert.pfx", "password", 
    X509KeyStorageFlags.MachineKeySet | X509KeyStorageFlags.PersistKeySet);

// SS mode
client.LoginWithCertificate(cert);

// HSS mode
client.LoginWithCertificateAndDataBoxId(cert, dataBoxId);

Certificate Conversion with OpenSSL

When working with certificates, you may need to convert between formats. Here are common scenarios:

1. Convert DER Certificate to PEM (for Data Box UI Import)

If you have a DER-encoded certificate and need to import it into the Data Box web interface:

openssl x509 -inform DER -in your_certificate.crt -out certificate.pem

This converts a binary DER certificate to text-based PEM format that can be imported in the Data Box settings.

2. Create PFX/P12 with Private Key (for HSS Authentication)

If you have a certificate request generated via iSignum or similar tool and received the certificate, you need to combine it with your private key:

openssl pkcs12 -export -out certificate_with_key.pfx -inkey your_private_key.pem -in your_certificate.crt

Where:

• your_private_key.pem is the private key you generated when creating the certificate request
• your_certificate.crt is the certificate you received (can be DER or PEM format)
• certificate_with_key.pfx is the output file you'll use for authentication

Important: The resulting PFX file contains both the certificate and the private key, which is required for HSS mode authentication. The library will validate that the certificate has a private key and throw a helpful error if it's missing.

3. Verify Certificate Has Private Key

To verify your PFX certificate contains a private key:

openssl pkcs12 -info -in certificate.pfx

You should see -----BEGIN PRIVATE KEY----- or -----BEGIN ENCRYPTED PRIVATE KEY----- in the output.

Result Wrapper

All API methods return a DatovkaResult<T> or DatovkaListResult<T> wrapper that provides:

• Data: The typed result data
• StatusCode: ISDS status code ("0000" = success)
• StatusMessage: Human-readable status message
• IsSuccess: Boolean indicating success (StatusCode == "0000")
• RawResponse: The complete SOAP response object for debugging

Basic Result Handling

var result = await client.Api.GetDataBoxInfoAsync();

// Check success
if (result.IsSuccess)
{
    Console.WriteLine($"Data Box ID: {result.Data.dbID}");
}
else
{
    Console.WriteLine($"Error {result.StatusCode}: {result.StatusMessage}");
}

// Access raw response if needed
var rawResponse = result.RawResponse;

List Results

List operations return DatovkaListResult<T> with additional properties:

var result = await client.Api.GetListOfReceivedMessagesAsync(days: 90);

Console.WriteLine($"Found {result.Count} messages");

if (result.HasItems)
{
    foreach (var message in result.Data)
    {
        Console.WriteLine($"Subject: {message.dmAnnotation}");
    }
}

Helper Methods

// Throw exception if failed
var result = await client.Api.GetDataBoxInfoAsync();
result.ThrowIfFailed(); // Throws DataBoxException if not successful

// Get data or default value
var data = result.OrDefault(fallbackValue);

Usage Examples

Get Data Box Information

// Get information about your data box
var result = await client.Api.GetDataBoxInfoAsync();
if (result.IsSuccess)
{
    Console.WriteLine($"Data Box ID: {result.Data.dbID}");
}

// Get user information
var userResult = await client.Api.GetUserInfoAsync();
if (userResult.IsSuccess)
{
    Console.WriteLine($"User ID: {userResult.Data.userID}");
}

// Get password expiration date
var pwdResult = await client.Api.GetPasswordExpiresAsync();
if (pwdResult.IsSuccess && pwdResult.Data.HasValue)
{
    Console.WriteLine($"Password expires: {pwdResult.Data}");
}

List Received Messages

// Get received messages from last 90 days, max 1000 messages
var result = await client.Api.GetListOfReceivedMessagesAsync(days: 90, limit: 1000);

if (result.IsSuccess)
{
    Console.WriteLine($"Found {result.Count} messages");
    
    foreach (var message in result.Data)
    {
        Console.WriteLine($"Message ID: {message.dmID}");
        Console.WriteLine($"Subject: {message.dmAnnotation}");
        Console.WriteLine($"Sender: {message.dmSender}");
        Console.WriteLine($"Delivery Time: {message.dmDeliveryTime}");
    }
}

Download Messages

// Download signed received message (ZFO format)
var messageId = "123456789";
var result = await client.Api.DownloadSignedReceivedMessageAsync(messageId);

if (result.IsSuccess)
{
    File.WriteAllBytes("message.zfo", result.Data);
    Console.WriteLine("Message downloaded successfully");
}

// Download delivery info
var deliveryResult = await client.Api.DownloadDeliveryInfoAsync(messageId);
if (deliveryResult.IsSuccess)
{
    File.WriteAllBytes("delivery.zfo", deliveryResult.Data);
}

Download Attachments

var result = await client.Api.GetReceivedDataMessageAttachmentsAsync(messageId);

if (result.IsSuccess && result.HasItems)
{
    foreach (var attachment in result.Data)
    {
        Console.WriteLine($"Attachment: {attachment.FileName}");
        Console.WriteLine($"MIME Type: {attachment.MimeType}");
        Console.WriteLine($"Size: {attachment.Content.Length} bytes");
        
        // Save attachment
        attachment.SaveToFile($"downloads/{attachment.FileName}");
    }
}

Send Messages

Using the Fluent Message Builder (Recommended)

using DatovkaSharp;

// Build a message using the fluent API
var message = new DatovkaMessageBuilder()
    .To("recipient-databox-id")
    .WithSubject("Important Document")
    .WithSenderRefNumber("REF-2024-001")
    .AsPersonalDelivery(true)
    .AddAttachment("path/to/document.pdf")
    .AddAttachment("path/to/invoice.pdf")
    .AddTextContent("readme.txt", "Please review the attached documents.")
    .Build(); // Validates automatically

// Send the message with automatic validation
var result = await client.Api.SendDataMessageAsync(message);

if (result.IsSuccess)
{
    Console.WriteLine($"✓ Message sent successfully!");
    Console.WriteLine($"  Message ID: {result.Data.dmID}");
    Console.WriteLine($"  Status: {result.StatusCode} - {result.StatusMessage}");
}
else
{
    Console.WriteLine($"✗ Error {result.StatusCode}: {result.StatusMessage}");
}

Using the Simple API

// Create a message with attachments
var attachmentPaths = new List<string>
{
    "path/to/document.pdf",
    "path/to/image.jpg"
};

var message = client.Api.CreateBasicDataMessage(
    recipientDataBoxId: "recipient-id",
    subject: "Test message",
    attachmentPaths: attachmentPaths
);

// Send the message (automatically validated)
var result = await client.Api.SendDataMessageAsync(message);

Search for Data Boxes

// Search by ID
var result = await client.Api.FindDataBoxByIdAsync("databox-id");

if (result.IsSuccess && result.Data != null)
{
    Console.WriteLine("Data box found!");
}

// Search with custom criteria (name, address, etc.)
var searchCriteria = new Services.Search.tDbOwnerInfo
{
    // Set search criteria here
    dbID = "partial-id"
};
var searchResult = await client.Api.FindPersonalDataBoxAsync(searchCriteria);

Password Management

// Get enhanced password information
var result = await client.Api.GetEnhancedPasswordInfoAsync();
if (result.IsSuccess)
{
    Console.WriteLine($"Password expires: {result.Data.pswExpDate}");
}

// Change password
var changeResult = await client.Api.ChangePasswordAsync("currentPassword", "newPassword");
if (changeResult.IsSuccess && changeResult.Data)
{
    Console.WriteLine("Password changed successfully!");
}

Mark Message as Read

var result = await client.Api.MarkMessageAsDownloadedAsync(messageId);
if (result.IsSuccess && result.Data)
{
    Console.WriteLine("Message marked as downloaded");
}

Message Validation

The library includes automatic validation when sending messages:

using DatovkaSharp.Exceptions;

try
{
    var message = new DatovkaMessageBuilder()
        .To("recipient-id")
        .WithSubject("Test")
        .AddAttachment("large-file.pdf") // Validates size
        .Build(); // Validates on Build()
        
    var result = await client.Api.SendDataMessageAsync(message); // Also validates before sending
    
    if (!result.IsSuccess)
    {
        Console.WriteLine($"Send failed: {result.StatusMessage}");
    }
}
catch (MissingRequiredFieldException ex)
{
    Console.WriteLine($"Missing required field: {ex.FieldName}");
}
catch (FileSizeOverflowException ex)
{
    Console.WriteLine($"File too large: {ex.CurrentSize} bytes (max: {ex.MaxSize})");
}
catch (RecipientCountOverflowException ex)
{
    Console.WriteLine($"Too many recipients: {ex.Count} (max: {ex.MaxCount})");
}
catch (MissingMainFileException ex)
{
    Console.WriteLine($"At least one attachment is required");
}

Validation Rules

• Maximum 50 recipients per message
• Maximum 25 MB total attachment size
• At least 1 attachment required (Czech Data Box requirement)
• Subject/annotation is required
• At least one recipient is required

Advanced Usage

Checking Message Builder Status

var builder = new DatovkaMessageBuilder()
    .To("recipient-id")
    .WithSubject("Test");

// Check current size before adding more attachments
long currentSize = builder.GetCurrentTotalSize();
Console.WriteLine($"Current size: {currentSize} bytes");

// Check attachment count
int count = builder.GetAttachmentCount();
Console.WriteLine($"Attachments: {count}");

// Add attachment conditionally
if (currentSize + fileSize < MessageValidator.MaxTotalSizeBytes)
{
    builder.AddAttachment(filePath);
}

Error Handling

var result = await client.Api.SendDataMessageAsync(message);

// Multiple ways to handle errors
if (!result.IsSuccess)
{
    // Option 1: Check status code
    switch (result.StatusCode)
    {
        case "0000":
            Console.WriteLine("Success");
            break;
        case "1216":
            Console.WriteLine("Cannot send to own mailbox");
            break;
        case "1205":
            Console.WriteLine("Insufficient credits");
            break;
        default:
            Console.WriteLine($"Error: {result.StatusMessage}");
            break;
    }
}

// Option 2: Throw exception on failure
try
{
    result.ThrowIfFailed();
    Console.WriteLine($"Message sent: {result.Data.dmID}");
}
catch (DataBoxException ex)
{
    Console.WriteLine($"Failed: {ex.Message}");
}

// Option 3: Get data with fallback
var messageId = result.OrDefault(null)?.dmID;

API Reference

DatovkaClient

Main client class for connecting to the Data Box service.

• LoginWithUsernameAndPassword(string username, string password) - Authenticate with credentials
• LoginWithCertificate(string certificatePath, string password) - Authenticate with certificate
• TestConnection() - Test the connection to the service
• Dispose() - Clean up resources

DatovkaApi

Simplified API for common operations. All methods return DatovkaResult<T> or DatovkaListResult<T>.

Information Methods

• GetDataBoxInfoAsync() - Get data box information
• GetUserInfoAsync() - Get user information
• GetPasswordExpiresAsync() - Get password expiration date
• GetEnhancedPasswordInfoAsync() - Get enhanced password information
• GetStatsAsync() - Get ISDS statistics

Message Operations

• GetListOfReceivedMessagesAsync(int days, int limit) - List received messages
• GetListOfSentMessagesAsync(int days, int limit) - List sent messages
• SendDataMessageAsync(tMessageCreateInput message) - Send a message
• MarkMessageAsDownloadedAsync(string messageId) - Mark message as read

Download Operations

• DownloadSignedReceivedMessageAsync(string messageId) - Download signed received message
• DownloadSignedSentMessageAsync(string messageId) - Download signed sent message
• DownloadDeliveryInfoAsync(string messageId) - Download delivery receipt
• GetReceivedDataMessageAttachmentsAsync(string messageId) - Get message attachments

Search Operations

• FindDataBoxByIdAsync(string dataBoxId) - Search data box by ID
• FindPersonalDataBoxAsync(tDbOwnerInfo searchCriteria) - Search with custom criteria

Password Management

• ChangePasswordAsync(string currentPassword, string newPassword) - Change password

DatovkaMessageBuilder

Fluent API for building messages.

• To(string recipientDataBoxId) - Set recipient
• WithSubject(string subject) - Set subject
• WithSenderRefNumber(string refNumber) - Set sender reference number
• WithRecipientRefNumber(string refNumber) - Set recipient reference number
• AsPersonalDelivery(bool isPersonalDelivery) - Set personal delivery flag
• AddAttachment(string filePath) - Add file attachment
• AddTextContent(string fileName, string content) - Add text content as attachment
• GetCurrentTotalSize() - Get current total attachment size
• GetAttachmentCount() - Get attachment count
• Build() - Build and validate the message

Result Types

DatovkaResult<T>

• Data - The typed result data
• StatusCode - ISDS status code
• StatusMessage - Status message
• IsSuccess - True if StatusCode == "0000"
• RawResponse - Raw SOAP response
• ThrowIfFailed() - Throw exception if not successful
• OrDefault(T defaultValue) - Get data or default value

DatovkaListResult<T>

Extends DatovkaResult<List<T>> with additional properties:

• Count - Number of items
• HasItems - True if count > 0

Exception Types

• DataBoxException - Base exception class
• FileSizeOverflowException - Attachment size exceeds limit
• RecipientCountOverflowException - Too many recipients
• MissingRequiredFieldException - Required field is missing
• MissingMainFileException - No attachments provided
• ConnectionException - Connection error

Project Structure

DatovkaSharp/
├── DatovkaSharp/           # Main library
│   ├── DataBoxEnvironment.cs
│   ├── DataBoxException.cs
│   ├── DatovkaClient.cs    # Main client
│   ├── DatovkaApi.cs       # Simplified API
│   ├── DatovkaResult.cs    # Result wrapper
│   ├── DatovkaListResult.cs # List result wrapper
│   ├── DatovkaMessageBuilder.cs # Fluent message builder
│   ├── DataBoxAttachment.cs
│   ├── DataBoxHelper.cs
│   ├── MessageValidator.cs # Message validation
│   ├── Exceptions/         # Custom exceptions
│   ├── Services/           # Generated SOAP clients
│   └── Resources/          # WSDL files
└── DatovkaSharp.Tests/     # NUnit tests
    ├── DatovkaClientTests.cs
    ├── MessageOperationsTests.cs
    ├── MessageBuilderTests.cs
    ├── AttachmentTests.cs
    └── SearchTests.cs

Requirements

• .NET Standard 2.0 or higher
• System.ServiceModel.Http (>= v4.10.3)

Testing

dotnet test

Test credentials (for test environment) are required. Create two test accounts as described here: https://info.mojedatovaschranka.cz/info/cs/74.html.

License

This library is licensed under the MIT license. 💜