github.com/vchain-us/vcn@v0.9.11-0.20210921212052-a2484d23c0b3/docs/cmd/vcn_notarize.md (about) 1 ## vcn notarize 2 3 Notarize an asset onto the blockchain 4 5 ### Synopsis 6 7 8 Notarize an asset onto the blockchain. 9 10 Notarization calculates the SHA-256 hash of a digital asset 11 (file, directory, container's image). 12 The hash (not the asset) and the desired status of TRUSTED are then 13 cryptographically signed by the signer's secret (private key). 14 Next, these signed objects are sent to the blockchain where the signer’s 15 trust level and a timestamp are added. 16 When complete, a new blockchain entry is created that binds the asset’s 17 signed hash, signed status, level, and timestamp together. 18 19 Note that your assets will not be uploaded. They will be processed locally. 20 21 Assets are referenced by passed ARG with notarization only accepting 22 1 ARG at a time. 23 24 Pipe mode: 25 If '-' is provided (echo my-file | vcn n -) stdin is read and parsed. Only pipe ARGs are processed. 26 27 Environment variables: 28 VCN_USER= 29 VCN_PASSWORD= 30 VCN_NOTARIZATION_PASSWORD= 31 VCN_NOTARIZATION_PASSWORD_EMPTY= 32 VCN_OTP= 33 VCN_OTP_EMPTY= 34 VCN_LC_HOST= 35 VCN_LC_PORT= 36 VCN_LC_CERT= 37 VCN_LC_SKIP_TLS_VERIFY=false 38 VCN_LC_NO_TLS=false 39 VCN_LC_API_KEY= 40 41 42 ARG must be one of: 43 wildcard 44 file 45 directory 46 file://<file> 47 dir://<directory> 48 git://<repository> 49 docker://<image> 50 podman://<image> 51 wildcard://"*" 52 javacom://<java project component> 53 nodecom://<node component> 54 gocom://<Go module in name@version format> 55 pythoncom://<Python module in name@version format> 56 dotnetcom://<.Net module in name@version format> 57 58 59 ``` 60 vcn notarize [flags] 61 ``` 62 63 ### Examples 64 65 ``` 66 vcn notarize my-file" 67 vcn notarize -r "*.md" 68 echo my-file | vcn n - 69 ``` 70 71 ### Options 72 73 ``` 74 --alert-email string set the alert email recipient (ignored if --create-alert is not set) 75 --alert-name string set the alert name (ignored if --create-alert is not set) 76 --attach vcn a binary1 --attach=vscanner.result:jobid123 add user defined file attachments. Ex. vcn n myfile --attach mysecondfile. (repeat --attach for multiple entries). It's possible to specify a label for each entry, Ex: --attach=vscanner.result:jobid123. In this way it will be possible to retrieve the specific attachment with vcn a binary1 --attach=vscanner.result:jobid123 or `vcn a binary1 --attach=jobid123` to get all attachments 77 -a, --attr key=value add user defined attributes (repeat --attr for multiple entries) 78 --bom auto-notarize asset dependencies and link dependencies to the asset 79 --bom-cascade cascade the operation to all assets that include the asset being processed 80 --bom-container-binary strings list of binaries to be executed inside the container - only the relevant dependencies will be processed 81 --bom-cyclonedx-json string name of the file to output BoM in CycloneDX JSON format 82 --bom-cyclonedx-xml string name of the file to output BoM in CycloneDX XML format 83 --bom-debug show extra debug info for BoM processing, also disable progress indicators 84 --bom-deps-only notarize only the dependencies, not the asset 85 --bom-file string use specified BoM file rather then resolve dependencies 86 --bom-force force notarization of untrusted dependencies, force cascade operation 87 --bom-hashes strings hashes of the dependencies (disables automatic dependency resolution) 88 --bom-signerID string signerID to use for authenticating dependencies 89 --bom-spdx string name of the file to output BoM in SPDX format 90 --ci-attr detect CI environment variables context if presents and inject 91 --create-alert if set, an alert will be created (config will be stored into the .vcn dir) 92 --hash string specify the hash instead of using an asset, if set no ARG(s) can be used 93 -h, --help help for notarize 94 --lc-api-key string Codenotary Cloud server api key 95 --lc-cert string local or absolute path to a certificate file needed to set up tls connection to a Codenotary Cloud server 96 --lc-host string if set with host, action will be route to a Codenotary Cloud server 97 --lc-no-tls allow insecure connections when connecting to a Codenotary Cloud server 98 --lc-port string set port for set up a connection to a Codenotary Cloud server (default 443). If --lc-no-tls is provided default port will be 80 (default "443") 99 --lc-skip-tls-verify disables tls certificate verification when connecting to a Codenotary Cloud server 100 -n, --name string set the asset name 101 --no-ignore-file if set, .vcnignore will be not written inside the targeted dir (affects dir:// only) 102 -p, --public when notarized as public, the asset name and metadata will be visible to everyone 103 --read-only if set, no files will be written into the targeted dir (affects dir:// only) 104 -r, --recursive if set, wildcard usage will walk inside subdirectories of provided path 105 ``` 106 107 ### Options inherited from parent commands 108 109 ``` 110 -o, --output string output format, one of: --output=json|--output=yaml|--output=''. In Codenotary Cloud authenticate command is possible to specify also --output=attachments. It permits to download all items attached to an artifact. 111 -S, --silent silent mode, don't show progress spinner, but it will still output the result 112 --vcnpath string config files (default is /tmp/.vcn/config.json on linux, c:\temp\config.json or c:\windows\temp\config.json on Windows) 113 --verbose if true, print additional information 114 ``` 115 116 ### SEE ALSO 117 118 * [vcn](vcn.md) - vChain CodeNotary - Notarize and authenticate, from code to production 119 120 ###### Auto generated by spf13/cobra on 18-Aug-2021