Skip to content

Latest commit

 

History

History
64 lines (46 loc) · 4.54 KB

README.md

File metadata and controls

64 lines (46 loc) · 4.54 KB
Raw

Tozny's C# Software Developers Kit

The Tozny Platform offers powerful tools for developers, enabling them to incorporate strong end-to-end encryption into their code bases. The Software Developer Kits provide the tools necessary for implementing the Tozny Platform without needing high cryptography expertise.

Testing

Records

Before you begin testing, you'll need a TOZ Store client config, which you can obtain through several methods. One approach is to visit the Tozny Dashboard and create an account. Then navigate to TOZ Store > Tokens to create a registration token. After that, proceed to TOZ Store > Clients to set up a new client. Click on the name of the client you've created, then locate and select tozny.key_backup and copy the client config. Another approach is to use one of our Software Developers Kits, such as our JavaScript SDK.

The next thing you need to decrypt a record is an encrypted TOZ Store record. You can create an encrypted record via the Dashboard or one of our SDKs. There is no direct way to obtain the encrypted record stored on our server, however there are several workarounds. Here are two suggestions:

  • Using the JavaScript SDK: Clone a local copy of the js-sdk to your device and install it into a node project.
    • Creating a record: Use the writeRecord() function, passing in a string for the type, and a key value pair object for the data (this will be encrypted) and metadata (this will remain unencrypted).
    • Getting an encrypted record: Add console.log(record) before decrypting the record here. Import the local copy of the js-sdk to a node project and follow the js-sdk documentation to create and read a record. When reading the record, the encrypted record will now print to your console.
  • Using the Dashboard:
    • Creating a record: Select any client in your dashboard and click the + button next to the Records header. You will be prompted to add the record type and any data (this will be encrypted) and metadata (this will remain unencrypted) key value pairs.
    • Getting an encrypted record: Click on the newly created record and locate your network requests in your browser. Select the request for https://api.e3db.com/v1/storage/records/[record ID]. The encrypted record will be printed in the response. All encrypted data is listed under data.
  • Using the C SDK: Follow the C SDK instructions to create a record, and run the example script to print the encrypted record.

Now that you have an encrypted record and a client config, you can fetch an access key and decrypt your record.

The test file is already populated with a valid example client config and an example access key. There are no updates required to run the tests. However, if you wish to use your own client or record info you simply need to update the test file:

  • Update the TestRecordApiShouldFetchAccessKey test with your client config details. Note that type passed into GetAccessKey() must already exist for the current client. GetAccessKey() fetches an existing access key from the server, which is based on the record type. A record type is assigned with creating a record. See the section on Records for information on how to create a record.
  • Update the TestRecordApiShouldDecryptRecord test with your access key and encrypted record. The record is formatted as a JSON string:
    @"[
        {
            'Hola': 'qlK8I8BxBFIXaolLTxEdT3pTOwr463Tw-G04Y-RzhweYzoIQghGDGohVI2QC1HHH.odxXRbEhb5aea_2f9KlU065pQKjNCjRB.BsXJPBCTSjI7fijPYBBdY-yVNNdC.Vz9U9K4Z9YNg7q1byBqncLXIJCs3CFXH',
            'Hello': 'jIyckoBr2CaYUqhGEQgoD3nKf3L24kdo60yCCg_dH4dOBuSI_ntGlNptynoE_PzG.jHPPcO4tMub85Pb-zfVFhBvKOETU19HN.6L0v4MrTvC1HKRVdJ8E0fy--_66L.92KBaICMD-YzOidw2ZpLpmtrK0DVzCB8',
        },
        {
            'Type': 'Example',
            'Company': 'Tozny',
            'Team': 'Software'
        }
    ]";

To run the tests in RecordApiTest.cs, run dotnet test --filter "FullyQualifiedName~TozSdkTest.RecordApiTests"

Publishing

To publish this SDK using Nuget package manager, first update the version by changing the value in TozSdk.csproj.

 <Version>New version number here</Version>

 Example:
 <Version>1.0.1</Version>

Then run the following commands:

dotnet build --configuration Release
dotnet pack --configuration Release

Then upload the .nupkg file in TozSdk/bin/Release to NuGet.