A .NET Standard client library and a CLI wrapper for using the Swisscom All-in Signing Service (AIS) to sign and/or timestamp PDF documents. The library(AIS project) can be used as a project dependency. You can also use the CLI wrapper as a command-line tool for batch operations. It relies on the iText library for PDF processing.
The standalone client library is available as a nuget package to refrence in your projects.
or see it on SharePoint:
To start using the Swisscom AIS service and this client library, do the following:
- Acquire an iText license
- Get authentication details to use with the AIS client.
- Build or download the AIS client binary package
- Configure the AIS client for your use case
- Use the AIS client, either programmatically or from the command line
Other topics of interest might be:
The rest of this page provides some quick examples for using the AIS client. Please see the links above for detailed instructions on how to get authentication data, download and configure the AIS client. The following snippets assume that you are already set up.
Get a help listing by calling the client without any parameters:
.\CLI.exeor
..\CLI.exe -helpApply an On Demand signature with Step Up on a local PDF file:
.\CLI.exe -type ondemand-stepup -input local-sample-doc.pdf -output test-sign.pdf -config config.jsonYou can also add the following parameter for extra help:
- -v: verbose log output (sets the loggers to debug)
More than one file can be signed/timestamped at once:
.\CLI.exe -type ondemand-stepup -input doc1.pdf -input doc2.pdf -input doc3.pdf -config config.jsonYou don't have to specify the output file:
.\CLI.exe -type ondemand-stepup -input doc1.pdf -config config.jsonThe output file name is composed of the input file name plus a configurable suffix (by default it is "-signed-#time", where #time is replaced at runtime with the current date and time). You can customize this suffix:
.\CLI.exe -type ondemand-stepup -config config.json -input doc1.pdf -suffix -output-#time - The command starts with CLI.exe ….. instead of the various shell scripts used for Java.
- There is no -init command as the sample config folder is supplied along the executable(“config.json”) and the .NET does not have other config files like java(e.g., logback).
- The verbosity is in 2 layers. Either use “-v” for verbose or without it for less info.
- The -config argument should always be used. You can supply any name for the config file you like, but the .NET doesn’t assume a default config file and location like Java.
Once you add the AIS client library as a dependency to your project, you can configure it in the following way(the same is demostrated in Tests\TestFullyProgramaticConfiguration):
// load/deserialize or build the configuration properties
ConfigurationProperties properties = new ConfigurationProperties
{
ClientPollRounds = "10",
ClientPollIntervalInSeconds = "10",
ITextLicenseFilePath = "your-license-file", // if not supplied it will run in unlicensed mode
ServerRestSignUrl = "https://ais.swisscom.com/AIS-Server/rs/v1.0/sign",
ServerRestPendingUrl = "https://ais.swisscom.com/AIS-Server/rs/v1.0/pending",
ClientAuthKeyFile = "d:/Work/Swisscom/my-ais.key",
ClientAuthKeyPassword = "your-password",
ClientCertFile = "d:/Work/Swisscom/my-ais.crt",
SkipServerCertificateValidation = true, // set this to false if the server certificate is trusted
ClientHttpMaxConnectionsPerServer = "10",
ClientHttpRequestTimeoutInSeconds = "10"
};
// initialize a configuration for the rest client and initialize a rest client
RestClientConfiguration restClientConfiguration = new RestClientConfiguration(properties);
IRestClient restClient = new RestClient(restClientConfiguration);
// initialize the AIS client config
AisClientConfiguration aisClientConfiguration = new AisClientConfiguration(properties);
//build an AIS client and a UserData instance for with details about this signature
try
{
IAisClient aisClient = new AisClient(restClient, aisClientConfiguration);
UserData userData = new UserData
{
TransactionId = Guid.NewGuid().ToString(),
ClaimedIdentityName = "ais-90days-trial",
ClaimedIdentityKey = "OnDemand-Advanced",
DistinguishedName = "cn=Test Name, givenname=Test, surname=Test, c=US, serialnumber=0b5e3f1eb4b1a84b31ea3ff45fcab1049c95a00c",
StepUpLanguage = "en",
StepUpMessage = "Please confirm the signing of the document",
StepUpMsisdn = "40740634123",
SignatureReason = "For testing purposes",
SignatureLocation = "Topeka, Kansas",
SignatureContactInfo = "[email protected]",
SignatureStandard = new SignatureStandard("PAdES-baseline"),
RevocationInformation = new RevocationInformation("PAdES-baseline"),
ConsentUrlCallback = new ConsentUrlCallback()
};
//subscribe to the OnConsentUrlReceived event
userData.ConsentUrlCallback.OnConsentUrlReceived += LogAtConsole;
// populate a list of PdfHandle objects with details about the document to be signed.
List<PdfHandle> documents = new List<PdfHandle>
{
new PdfHandle
{
InputFileName = "input.pdf",
OutputFileName = "output-programatic.pdf",
DigestAlgorithm = DigestAlgorithm.SHA256
}
};
//do the signature
SignatureResult signatureResult = aisClient.SignWithOnDemandCertificateAndStepUp(documents, userData);
if (signatureResult == SignatureResult.SUCCESS) {
// yay!
}
}