Quickstart Help Guide
Give any digital asset a meaningful, globally-unique, immutable identity that is authentic, verifiable, traceable from anywhere.
When using CodeNotary in your DevOps, from source code, to release, deployment or runtime, you allow a continuous trust verification that can be used to detect unusual or unwanted activity in your workload and act on it. CodeNotary lets you notarize all of your digital assets that add a trust level of your choice, custom attributes and a meaningful status without touching or appending anything (unlike digital certificates). That allows change and revocation post-release without breaking any customer environment.
Everything is done in a global, collaborative way to break the common silo solution architecture. Leveraging an immutable, always-on DLT platform allows you to avoid complex setup of Certificate authorities or digital certificates (that are unfit for DevOps anyway).
The vcn command is published under GPL3 as Open Source, so you check the code base, build the binary yourself and help to improve the code. All code is written in Golang.
Just open https://dashboard.codenotary.io and set up your account.
Type in your email and CodeNotary automatically detect if you’re registered or not. If it’s your first time, just confirm your email and you’re all set.
First Dashboard Login
Setup your account and download the vcn command line tool for your operating system — available for Mac, Linux, and Microsoft Windows. We recommend getting familiar with the vcn tool by following the onboarding steps in the top bar of your dashboard.
As you don’t use vcn yet, make sure to check the download using traditional methods like md5 or sha256
Download vcn command line tool
You can find the latest vcn release on our GitHub page: https://github.com/vchain-us/vcn/releases
Download integrity check
Make sure to check the integrity of the downloaded file – no worries, from then on, you can use vcn for protecting the integrity of your files.
When using Linux just type:
When using Microsoft Windows:
certutil -hashfile C:\Users\YOUR_USERNAME\Downloads\vcn-v0.3.4-windows-4.0-amd64.exe SHA256
Microsoft Windows installer
We also offer a Microsoft Windows installer (codenotary_vcn_0.3.4_setup.exe) that does all the installation for you and registers vcn actions in the file context of Windows explorer.
Something to mention about any Executable you download from the internet – Windows is going to show an error if the Vendor didn’t buy an $500+/year certificate. That’s why CodeNotary is here, to get rid of these enormous costs that only make sure the Certification Authority is making a profit while providing absolutely no additional security.
Just select keep and run the installer. If you want to make sure the file integrity is perfectly fine, you better install the CodeNotary Chrome Extension immediately as it really protects against evil clones and fake downloads. Of course, you can also build the vcn command yourself or check the installer file on our GitHub repository. Nothing hidden!
Annoying Windows warnings
Of course that’s not it with the warnings. There will be another one, despite the fact that we actually notarized with a cheaper certificate. But only the expensive ones count.
Click ‘Run anyway’ to start the installer.
When the installation is successful, you can open vcn here and continue with this guideline.
Open vcn for Windows
vcn command first run
The first thing you should do after downloading vcn is making the file executable and copying the command to your environment path so you don’t need to search for it. Example:
sudo chmod +x vcn-v0.3.4-linux-amd64 && sudo cp vcn-v0.3.4-linux-amd64 /usr/local/bin/vcn
Now you can type vcn to run the command.
Now log into CodeNotary:
When you first login through the CLI, you will need to create your CodeNotary Keypair to be able to notarize files.
When running the Microsoft Windows vcn it looks like this (below):
vcn profile folder
That Keypair is stored under $HOME/.vcn (Linux) or %Home%\.vcn (Windows) and you need to use a strong password to protect the private key. Furthermore, you should protect the files within the .vcn directory.
When you check your dashboard, which also opens when you type vcn dashboard, you can find your public key that has just been created as well as the made progress.
That’s it. You are all set up and ready to go. You can now start notarizing digital assets of any kind:
- source code
- container (i. e. docker)
- media (maybe you own music or created videos)
- and much more
vcn command line
By the way, if you don’t notarize up, you will still be able to authenticate files, documents or other downloads using vcn authenticate <file>.
As all is set up, it’s time to get started by notarizing some downloaded files, documents or even docker container images.
vcn notarize <file> vcn notarize docker:<image>
Public and Private assets
By default all assets are notarized private, so not much information is disclosed about the signer.
If you want to make it public and therefore, more trusted, please use the –public switch.
vcn notarize --public <file> vcn notarize --public docker:<image>
NOTE: The most recent status will be applied to your asset (i.e. if you have notarized an asset first as public and then as private, it would be considered private).
Trust, Untrust, and Unsupport
Change the asset’s status — especially as a software publisher, ISV or developer you might want to set the status of your software to ‘Unsupported’ or ‘Untrusted’. CodeNotary will improve these features a lot to make sure that the owner of software has the highest trust level to do these actions.
vcn untrust <file> vcn unsupport <file>
If you want to check the files and the status in a browser you can either visit https://dashboard.codenotary.io or use the dashboard command to take a look at analytics and extended functionality on the dashboard (browser needed):
List your assets
To check what assets you’ve notarized, just type:
There is also a nice cheat sheet with all commands and some more advanced stuff which you can see below and access fully on our GitHub page here.
CodeNotary has just been released to the public, so please leave feedback and let us know how we can improve.
If you have any questions that haven’t been covered in our quick guide, please also check our FAQ page.