Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 1.75 KB

client-side-encryption.md

File metadata and controls

23 lines (15 loc) · 1.75 KB
Raw

Client-side encryption

Note: this page describes a feature that is not available to use with Structurizr's Free Plan.

The JSON representation of your workspace is stored on the Structurizr servers using AES encryption with a 128-bit key, a random salt and a server-side passphrase. For additional peace of mind, you can choose to encrypt your workspace with your own passphrase on the client before uploading it to Structurizr. In order to view a client-side encrypted workspace, you will be asked to enter your passphrase when you open the workspace in your web browser. The passphrase is then used to decrypt the workspace in your web browser - at no point does the passphrase leave your computer.

To use client-side encryption, simply create an instance of AesEncryptionStrategy and associate it with your StructurizrClient instance. For example:

StructurizrClient structurizrClient = new StructurizrClient("key", "secret");
structurizrClient.setEncryptionStrategy(new AesEncryptionStrategy("password"));
structurizrClient.putWorkspace(1234, workspace);

The default key size is 128 bits and the default iteration count is 1000. An alternative constructor for AesEncryptionStrategy takes the following parameters:

  • The key size (number of bits; e.g. 128, 192 or 256).
  • The iteration count (used when generating keys).
  • The passphrase.

In addition, a random salt and initialization vector are generated automatically for you, using Java's SecureRandom class.

See ClientSideEncryption.java for a full example, and https://structurizr.com/share/41 to access the workspace.