IPTranslator.Client 2.1.0

Prefix Reserved
dotnet add package IPTranslator.Client --version 2.1.0
                    
NuGet\Install-Package IPTranslator.Client -Version 2.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="IPTranslator.Client" Version="2.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="IPTranslator.Client" Version="2.1.0" />
                    
Directory.Packages.props
<PackageReference Include="IPTranslator.Client" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add IPTranslator.Client --version 2.1.0
                    
#r "nuget: IPTranslator.Client, 2.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package IPTranslator.Client@2.1.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=IPTranslator.Client&version=2.1.0
                    
Install as a Cake Addin
#tool nuget:?package=IPTranslator.Client&version=2.1.0
                    
Install as a Cake Tool

IPTranslator.Client

.NET client for the IPTranslator document translation job API: batch translation of .docx documents, end-to-end encrypted — the document is encrypted on your machine and decrypted only on the GPU worker that translates it; the web service relays it unopened.

  • Post-quantum E2E encryption: X-Wing KEM (ML-KEM-768 + X25519), AES-256-GCM bodies and blobs, hybrid-signed (Ed25519 + ML-DSA-65) key announcements. Details in docs/encryption.md.
  • Document jobs: create → upload → submit → poll → fetch, with optional dictionaries (csv/tsv/xlsx) and translation memories (tmx). Details in docs/document-jobs.md.
  • Targets netstandard2.0; dependencies: BouncyCastle.Cryptography, Newtonsoft.Json, Serilog.

This repository is intentionally small so the code — especially the cryptography — is practical to review. See SECURITY.md for reporting vulnerabilities.

Install

dotnet add package IPTranslator.Client

Quick start

You need an API key and the service's key material: either the pinned X-Wing public key (.xwing) or, recommended, the built-in announcement verification key (rotation-proof — the current service key is then obtained from the signed announcement in the Ping response).

using IPTranslator.Client;
using IPTranslator.Client.E2E;
using IPTranslator.Client.Messaging;
using IPTranslator.Contracts.Actions;

var requestHandler = new WebApiRequestHandler(
    "https://iptranslator.ipappify.de",
    new ApiKeyMessageHandler(apiKey));

// resolve the service public key from the signed announcement (verified
// against the built-in verification key; the web service cannot forge it)
var ping = await new ManagementClient(requestHandler).Ping(new Ping.Request());
var servicePublicKey = SignedKeyAnnouncement.Parse(ping.SignedServicePublicKey)
    .VerifyAndGetPublicKey(E2EDefaults.ServiceVerificationKey);

var client = new DocumentJobClient(requestHandler, servicePublicKey);

// submit: the document is encrypted locally before upload
var handle = await client.Submit("patent.docx", await File.ReadAllBytesAsync("patent.docx"),
    sourceLanguage: "de", targetLanguage: "en", finalize: true);

// poll: the server holds the call up to 20 s and returns early on changes
GetDocumentJob.Response status;
do { status = await client.GetStatus(handle, waitSeconds: 20); }
while (status.State is DocumentJobStateEnum.queued or DocumentJobStateEnum.running);

// fetch + decrypt the result, end-to-end verified
var result = await client.GetResult(handle);
await File.WriteAllBytesAsync("patent.en.docx", result.Document);
Console.WriteLine($"billed units: {result.ConsumedUnits}");

Example CLI

examples/IPTranslator.Client.Cmd is a complete reference implementation:

ipt-client-cmd input.docx output.docx service.hybrid --src de --trg en \
    [-f] [-d terms.xlsx] [-m memory.tmx]... [-k <api-key>]

The key file is either the pinned X-Wing public key (*.xwing) or the announcement verification key (*.hybrid); the API key can also be supplied via the IPT_API_KEY environment variable. Run without arguments for full usage.

dotnet run --project examples/IPTranslator.Client.Cmd -- ...

Building and tests

dotnet build IPTranslator.Client.slnx
dotnet test IPTranslator.Client.slnx

The tests include cross-language vectors shared with the service (message AAD formats, iptd-doc:v1 blobs, announcement signatures), pinned dev keys, and tamper-detection cases.

Repository layout

src/IPTranslator.Client/        the NuGet package (client, E2E crypto, wire contracts)
examples/IPTranslator.Client.Cmd/  reference CLI
tests/IPTranslator.Client.Tests/   crypto + protocol tests
docs/                           encryption and document-job protocol docs

This repository is a curated extract of the IPTranslator codebase: it contains exactly the client pieces needed for the document job API (plus Ping for key announcements). The full product (Word add-in, interactive translation, GenAI review) lives in a private repository which is authoritative; changes here are synced from it.

License

MIT

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.1.0 159 7/19/2026