Using External Access Signing Helper CLI

Available in Classic and VPC

This page provides information on using the External Access Signing Helper CLI provided by External Access.

1. Signing Helper CLI download and unzip

1.1. Download CLI

Download Signing Helper CLI file compatible for your operating system.

• Linux
• macOS
• Windows

1.2. Unzip

Windows

# Windows
$ unzip ncp_signing_helper-{version}.windows.arm64.zip
ex) unzip ncp_signing_helper-v1.0.1.windows.arm64.zip
$ chmod +x ./ncp_signing_helper.exe

Linux and macOS

# Linux
$ tar -xzvf ncp_signing_helper-{version}.linux.arm64.tar.gz
ex) tar -xzvf ncp_signing_helper-v1.0.1.linux.arm64.tar.gz
$ chmod +x ./ncp_signing_helper
 
# macOS
$ tar -xzvf ncp_signing_helper-{version}.darwin.arm64.tar.gz
ex) tar -xzvf ncp_signing_helper-v1.0.1.darwin.arm64.tar.gz
$ chmod +x ./ncp_signing_helper

2. Run CLI

2.2. Available Commands

version command
If you run version command, you are able to verify if the Signing Helper CLI is installed correctly and check its version.

./ncp_signing_helper version

help command
If you run help command, you are able to view the available commands and their descriptions for the Signing Helper.

./ncp_signing_helper help

credential-process command
If you run credential-process command, you are able to send a request to IAM external access and retrieve temporary credentials.

• credential-process --help run
  You can view the description of the credential-process command along with its flags.

  ./ncp_signing_helper credential-process --help
  

• credential-process flags
  The flags available for use with the credential-process command.

  Flag	Default	Type	Description	Required
  --role-nrn	""	string	nrn of the role to be used	Y
  --profile-nrn	""	string	nrn of the profile from which the policy will be loaded	Y
  --trust-anchor-nrn	""	string	nrn of the trust anchor to be used for authentication	Y
  --certificate	""	string	Path to the certificate file	Y
  --intermediates	""	string	Path to the intermediate certificate file	N
  --private-key	""	string	Path to the private key file	Y
  --session-duration	3600	int	Session hold time (seconds)	N
  --debug	false	bool	Whether debug output is enabled	N
  --with-proxy	false	bool	Whether proxy is used for CreateSession request	N
  --endpoint	"https://externalaccess.apigw.ntruss.com/auth/v1"	string	Endpoint used for the CreateSession request	N
  --format	"ncp"	string	Specify the credential output format (available options: "ncp", "aws").	N

• credential-process command run and retrieving temporary credentials
  Run the credential-process command to send a request to IAM external access using the certificate and private key files to obtain temporary credentials.

  ./ncp_signing_helper credential-process \
  --certificate {certificate file path} \
  --private-key {private key file path} \
  --trust-anchor-nrn {trust anchor nrn} \
  --profile-nrn {profile nrn} \
  --role-nrn {role nrn}
  

    "accessKey": "ncp_iam_BPSRK...WoqKhg3",
    "keySecret": "ncp_iam_BPTR...ypJklM3QbK",
    "createTime": "2024-09-30T08:31:07Z",
    "expireTime": "2024-09-30T09:31:07Z"
  }