github.com/vchain-us/vcn@v0.9.11-0.20210921212052-a2484d23c0b3/docs/cmd/vcn_authenticate.md (about) 1 ## vcn authenticate 2 3 Authenticate assets against the blockchain 4 5 ### Synopsis 6 7 8 Authenticate assets against the blockchain. 9 10 Authentication is the process of matching the hash of a local asset to 11 a hash on the blockchain. 12 If matched, the returned result (the authentication) is the blockchain-stored 13 metadata that’s bound to the matching hash. 14 Otherwise, the returned result status equals UNKNOWN. 15 16 Note that your assets will not be uploaded but processed locally. 17 18 The exit code will be 0 only if all assets' statuses are equal to TRUSTED. 19 Otherwise, the exit code will be 1. 20 21 Assets are referenced by the passed ARG(s), with authentication accepting 22 1 or more ARG(s) at a time. Multiple assets can be authenticated at the 23 same time while passing them within ARG(s). 24 25 ARG must be one of: 26 <file> 27 file://<file> 28 dir://<directory> 29 git://<repository> 30 docker://<image> 31 podman://<image> 32 javacom://<java mvn jar or pom.xml> 33 gocom://<Go module in name@version format> 34 pythoncom://<Python module in name@version format> 35 dotnetcom://<.Net module in name@version format> 36 Environment variables: 37 VCN_USER= 38 VCN_PASSWORD= 39 VCN_NOTARIZATION_PASSWORD= 40 VCN_NOTARIZATION_PASSWORD_EMPTY= 41 VCN_OTP= 42 VCN_OTP_EMPTY= 43 VCN_LC_HOST= 44 VCN_LC_PORT= 45 VCN_LC_CERT= 46 VCN_LC_SKIP_TLS_VERIFY=false 47 VCN_LC_NO_TLS=false 48 VCN_LC_API_KEY= 49 VCN_LC_LEDGER= 50 VCN_SIGNING_PUB_KEY_FILE= 51 VCN_SKIP_SIGNATURE_VERIFY= 52 53 ``` 54 vcn authenticate [flags] 55 ``` 56 57 ### Examples 58 59 ``` 60 vcn authenticate /bin/vcn 61 ``` 62 63 ### Options 64 65 ``` 66 --alerts specify to authenticate and monitor for the configured alerts, if set no ARG(s) can be used 67 --attach string authenticate an artifact on a specific attachment label. With this it's be possible to retrieve the specific attachment with: 68 vcn a binary1 --attach=vscanner.result:jobid123 --output=attachments 69 or to get all attachments for a label: 70 vcn a binary1 --attach=jobid123 --output=attachments 71 --bom link asset to its dependencies from BoM 72 --bom-container-binary strings list of binaries to be executed inside the container - only the relevant dependencies will be processed 73 --bom-cyclonedx-json string name of the file to output BoM in CycloneDX JSON format 74 --bom-cyclonedx-xml string name of the file to output BoM in CycloneDX XML format 75 --bom-debug show extra debug info for BoM processing, also disable progress indicators 76 --bom-deps-only authenticate only the dependencies, not the asset 77 --bom-file string store BoM int the file for later processing 78 --bom-max-unsupported float max number (in %) of unsupported dependencies 79 --bom-spdx string name of the file to output BoM in SPDX format 80 --bom-trust-level string min trust level: untrusted (unt) / unsupported (uns) / unknown (unk) / trusted (t) (default "trusted") 81 --bom-what-includes output all assets that use the specified asset 82 --exit-code int override default exit codes in case of success 83 --force if provided when downloading attachments files are silently overwritten 84 --hash string specify a hash to authenticate, if set no ARG(s) can be used 85 -h, --help help for authenticate 86 --lc-api-key string Codenotary Cloud server api key 87 --lc-cert string local or absolute path to a certificate file needed to set up tls connection to a Codenotary Cloud server 88 --lc-host string if set with host, action will be route to a Codenotary Cloud server 89 --lc-ledger string Codenotary Cloud ledger. Required when a multi-ledger API key is used. 90 --lc-no-tls allow insecure connections when connecting to a Codenotary Cloud server 91 --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") 92 --lc-skip-tls-verify disables tls certificate verification when connecting to a Codenotary Cloud server 93 --lc-uid string authenticate on a specific artifact uid 94 -I, --org string accept only authentications matching the passed organisation's ID, 95 if set no SignerID can be used 96 (overrides VCN_ORG env var, if any) 97 -s, --signerID strings accept only authentications matching the passed SignerID(s) 98 (overrides VCN_SIGNERID env var, if any). It's valid both for blockchain and ledger compliance 99 ``` 100 101 ### Options inherited from parent commands 102 103 ``` 104 -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. 105 -S, --silent silent mode, don't show progress spinner, but it will still output the result 106 --vcnpath string config files (default is /tmp/.vcn/config.json on linux, c:\temp\config.json or c:\windows\temp\config.json on Windows) 107 --verbose if true, print additional information 108 ``` 109 110 ### SEE ALSO 111 112 * [vcn](vcn.md) - vChain CodeNotary - Notarize and authenticate, from code to production 113 114 ###### Auto generated by spf13/cobra on 18-Aug-2021