Securibox.CloudAgents 0.1.9

.NET Standard 2.0
dotnet add package Securibox.CloudAgents --version 0.1.9
NuGet\Install-Package Securibox.CloudAgents -Version 0.1.9
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="Securibox.CloudAgents" Version="0.1.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Securibox.CloudAgents --version 0.1.9
#r "nuget: Securibox.CloudAgents, 0.1.9"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Securibox.CloudAgents as a Cake Addin
#addin nuget:?package=Securibox.CloudAgents&version=0.1.9

// Install Securibox.CloudAgents as a Cake Tool
#tool nuget:?package=Securibox.CloudAgents&version=0.1.9

cloudagents-net

A .NET library for the Securibox Cloud Agents API.

Nuget

NuGet

Install-Package Securibox.CloudAgents

The Securibox.CloudAgents SDK for .NET binaries are only distributed via nuget. For those using older versions of Visual Studio that does not support NuGet Package Manager, please download the command line version of NuGet.exe and run the following command.

nuget install Securibox.CloudAgents

Authentication

In order to secure the Securibox Cloud Agents API, three mechanisms have been implemented. Here is a brief overview of the three mechanisms as well as code snippets to help you integrate the correct mechanism in order to call the APIs.

Basic API Authentication w/ TLS

Basic API authentication is the easiest of the three to implement offering the lowest security options of the common protocols. This mechanism is usually advised for testing purposes in order to test the APIs and only requires Securibox to provide a username and password.

BasicAuthConfig basicAuthConfig = new BasicAuthConfig("[BasicUsername]", "[BasicPassword]");
ApiClient apiClient = new ApiClient("https://sca-multitenant.securibox.eu", basicAuthConfig);

Or configuring in the app.config file:

<configuration>
  <configSections>
    <section name="SecuriboxCloudAgentsConfiguration" type="Securibox.CloudAgents.Configurations.SecuriboxCloudAgentsConfiguration, Securibox.CloudAgents"/>
  </configSections>
  <SecuriboxCloudAgentsConfiguration authMode="basic" baseAddress="https://sca-multitenant.securibox.eu/" username="username" password="password"/>
</configuration>

SSL Client Certificate Authentication

The SSL client certification is a mechanism allowing your application to authenticate itself with the Securibox Cloud Agents (SCA) servers. In this case, your application will send its SSL certificate after verifing the SCA server identity. Then, the client and server use both certificates to generate a unique key used to sign requests sent between them.

This kind of authentication is implemented when the customer call your servers that will then call the Securibox Cloud Agents API.

In order to use this type of authentication, Securibox will provide a PFX certificate file containing a passphrase protected private key and a public key that can be installed in the certificate store. The SDK can access the certificate store to perform client authentication:

CertAuthConfig authConfig = new CertAuthConfig("[CertificateThumbprint]");
ApiClient apiClient = new ApiClient("https://sca-multitenant.securibox.eu", authConfig);

Or configuring in the app.config file:

<configuration>
  <configSections>
    <section name="SecuriboxCloudAgentsConfiguration" type="Securibox.CloudAgents.Configurations.SecuriboxCloudAgentsConfiguration, Securibox.CloudAgents"/>
  </configSections>
  <SecuriboxCloudAgentsConfiguration authMode="cert" baseAddress="https://sca-multitenant.securibox.eu/" certThumbprint="[CertificateThumbprint]" />
</configuration>

Getting started

The following is the minimum needed code to list all agent details and fields:

BasicAuthConfig basicAuthConfig = new BasicAuthConfig("[BasicUsername]", "[BasicPassword]");
ApiClient apiClient = new ApiClient("https://sca-multitenant.securibox.eu", basicAuthConfig);
var agents = apiClient.AgentsClient.ListAgents();
foreach(var agent in agents){
    Console.WriteLine("\n\n\n------ Agent Details ------\n");
    Console.WriteLine("ID: " + agent.id + "\n");
    Console.WriteLine("Name: " + agent.Name + "\n");
    Console.WriteLine("Periodicity: " + agent.AgentPeriodicity + "\n");
    Console.WriteLine("Current Status: " + agent.AgentCurrentState + "\n");
    Console.WriteLine("Category: " + agent.CategoryId + "\n");
}

The following code is the minimum code needed to configure an agents and launch a synchronization:

//Configure credentials
var credentials = new List<Credential>
{
    new Credential {Position = 0, Value = "username", Alg = null },
    new Credential { Position = 1, Value = "password", Alg = null }
};

//Configure account properties    
var apiAccount = new Account
{
    AgentId = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX",
    CustomerAccountId = "customer_account_id",
    CustomerUserId = "customer_user_id",
    Mode = "Enabled",
    Name = "Account 1 - User defined name",
    Credentials = credentials
};

//Setup API authentication (basic) and client
BasicAuthConfig basicAuthConfig = new BasicAuthConfig("[BasicUsername]", "[BasicPassword]");
ApiClient apiClient = new ApiClient("https://sca-multitenant.securibox.eu", basicAuthConfig);

//Create the account which automatically launches a synchronization
var account = apiClient.AccountsClient.CreateAccount(apiAccount, true);

//Let's wait until the synchronization has reached a final status
var synchronization = apiClient.AccountsClient.GetLastSynchronizationsOfAccount(account.CustomerAccountId);
while (synchronization.SynchronizationStateDetails == SynchronizationStateDetails.NewAccount ||
        synchronization.SynchronizationStateDetails == SynchronizationStateDetails.Scheduled ||
       synchronization.SynchronizationStateDetails == SynchronizationStateDetails.Pending ||
       synchronization.SynchronizationStateDetails == SynchronizationStateDetails.InProgress)
{
    System.Threading.Thread.Sleep(5000);
    synchronization = apiClient.AccountsClient.GetLastSynchronizationsOfAccount(account.CustomerAccountId);
}

//Let's get the newly downloaded documents and save them locally
var documents = apiClient.DocumentsClient.SearchDocuments(apiAccount.CustomerAccountId);
foreach(var document in documents)
{
    byte[] documentContent = Convert.FromBase64String(document.Base64Content);
    System.IO.File.WriteAllBytes(@"C:\Temp\" + document.Name, documentContent);
    
    //Let's acknowlege the document
    _apiClient.DocumentsClient.AcknowledgeDocumentDelivery(document.Id);
}

Webview url

In order to use the webview and avoid having to implement the APIs to list and configure accounts, a webview has been developped. In this webview, a customer can:

  • Browse and search all agents
  • Have quick access to predefined favorite agents
  • List the configured agents
  • Configure, modify or delete an agent account
  • See the list of synchronizations for each account

To use the webview, activate it in the CloudAgents backoffice and use the provided PFX private key to sign the token.

The webview accepts the following url arguments:

  • token: json web token signed with the PFX certificate
  • callback: url where the user is sent on logging out <sub><sup>(ex: https://www.myapp.com - if a state has been provided: https://www.myapp.com?state={state})</sup></sub>
  • lang <sup>optional</sup>: culture to display the page - By default, in fr-FR

Example:

https://sca-webview.azurewebsites.net?token={token}&callback={callback_url}&state={stateData}
https://sca-webview.azurewebsites.net?token={token}&callback={callback_url}&state={stateData}&lang=en-us

For examples in .net to generate the token, please refer to the test.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
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
0.1.9 96 11/7/2022
0.1.8 253 11/22/2021
0.1.7 188 11/19/2021
0.1.6 258 7/28/2021
0.1.5 578 1/9/2020
0.1.4 377 11/27/2019
0.1.3 2,172 1/21/2019
0.1.2 1,270 9/20/2018
0.1.1 818 7/10/2018
0.1.0 1,050 6/20/2018
0.0.9 1,070 5/2/2018
0.0.8 1,414 1/18/2018
0.0.7 870 1/17/2018
0.0.6 843 1/16/2018
0.0.5 833 1/16/2018
0.0.4 777 1/16/2018
0.0.3 838 1/15/2018
0.0.2 779 1/15/2018
0.0.1 781 1/15/2018

Removed support for .NET 4.5.2, changed license to MIT and added ability to list disabled agents.