Secure Copy Protocol (SCP)

Secure Copy Protocol (SCP) connection to the CipherTrust Manager can be configured using the following:

• Managing SCP Connections using GUI

• Managing SCP Connections using ksctl

Managing SCP Connections using GUI

• Host - IP/Name of the destination host machine.

• Port - port number of the destination host machine. Default port is 22.

• Username - username of the SCP server.

• Auth Method - you can use either Password or Key for authentication purpose.

  • Password - destination host machine password.

  • Key - click the Download Public key for SSH authentication button and upload the fetched key to the list of authorized keys on the destination host machine.

• Public key of SCP Server - public key of the destination host machine. It is used to verify the identity of the host through key fingerprint. You can find it at the /etc/ssh location on the host machine.

• Path to - path of the destination host machine where backup will be transferred.

Click the Test Connection button to check whether the connection is configured correctly. If the test is successful, the status is OK else the status is Fail.

Click Next to move to the next step.

Managing SCP Connections using ksctl

The following operations can be performed:

• Create/Get/Update/Delete an SCP connection

• List all SCP connections

• Test an existing SCP connection

• Test a new SCP Connection

Creating an SCP Connection

To create an SCP connection, run:

Syntax

ksctl connectionmgmt scp create --name <Connection-Name> --host <Hostname> --scp-port <Port> --username <SCP-Connection-Username> --auth-method <Key or Password> --conn-password <SCP-Connection-Password> --path-to <Destination-Machine-Path> --public-key <key> --products <Products-Names> --meta <Key:Value>

Example Request

ksctl connectionmgmt scp create --name scp-conn --host 8.8.8.8 --scp-port 22 --username admin --auth-method password --conn-password paswd --public-key key --path-to "/home/scp" --products "backup/restore"

Example Response

{
    "id": "55ffad19-8c7c-4a33-8fc6-d2d2bca5deb5",
    "uri": "kylo:kylo:connectionmgmt:connections:scp-conn-55ffad19-8c7c-4a33-8fc6-d2d2bca5deb5",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2021-06-07T06:17:01.343933Z",
    "updatedAt": "2021-06-07T06:17:01.342893Z",
    "service": "scp",
    "category": "external-server",
    "last_connection_ok": null,
    "last_connection_at": "0001-01-01T00:00:00Z",
    "name": "scp-conn",
    "products": [
        "backup/restore"
    ],
    "meta": null,
    "host": "8.8.8.8",
    "port": 22,
    "username": "admin",
    "auth_method": "password",
    "path_to": "/home/scp"
}

Getting Details of an SCP Connection

To get details of an SCP connection, run:

Syntax

ksctl connectionmgmt scp get --id <Connection-Name/ID>

Example Request

ksctl connectionmgmt scp get --id scp-conn

Example Response

{
    "id": "55ffad19-8c7c-4a33-8fc6-d2d2bca5deb5",
    "uri": "kylo:kylo:connectionmgmt:connections:scp-conn-55ffad19-8c7c-4a33-8fc6-d2d2bca5deb5",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2021-06-07T06:17:01.343933Z",
    "updatedAt": "2021-06-07T06:17:01.342893Z",
    "service": "scp",
    "category": "external-server",
    "last_connection_ok": null,
    "last_connection_at": "0001-01-01T00:00:00Z",
    "name": "scp-conn",
    "products": [
        "backup/restore"
    ],
    "meta": null,
    "host": "8.8.8.8",
    "port": 22,
    "username": "admin",
    "auth_method": "password",
    "path_to": "/home/scp"
}

Updating an SCP Connection

To update an SCP connection, run:

Syntax

ksctl connectionmgmt scp modify --name <Connection-Name> --host <hostname> --scp-port <Port> --username <SCP-Connection-Username> --auth-method <Key or Password> --conn-password <SCP-Connection-Password> --public-key <key> --path-to <Destination-Machine-Path> --products <Products-Names> --meta <Key:Value>

Example Request

ksctl connectionmgmt scp modify --id scp-conn --host 1.2.3.4 --scp-port 32

Example Response

{
    "id": "55ffad19-8c7c-4a33-8fc6-d2d2bca5deb5",
    "uri": "kylo:kylo:connectionmgmt:connections:scp-conn-55ffad19-8c7c-4a33-8fc6-d2d2bca5deb5",
    "account": "kylo:kylo:admin:accounts:kylo",
    "createdAt": "2021-06-07T06:17:01.343933Z",
    "updatedAt": "2021-06-07T06:21:53.141454927Z",
    "service": "scp",
    "category": "external-server",
    "last_connection_ok": null,
    "last_connection_at": "0001-01-01T00:00:00Z",
    "name": "scp-conn",
    "products": [
        "backup/restore"
    ],
    "meta": null,
    "host": "1.2.3.4",
    "port": 32,
    "username": "admin",
    "auth_method": "password",
    "path_to": "/home/scp"
}

Deleting an SCP Connection

To delete an SCP connection, run;

Syntax

Syntax

ksctl connectionmgmt scp delete --id <Connection-Name/ID>

Example Request

ksctl connectionmgmt scp delete --id scp-conn

Example Response

There will be no response if SCP connection is deleted successfully.

Getting List of SCP Connections

To list all the SCP connections, run:

Syntax

ksctl connectionmgmt scp list 

Example Request

ksctl connectionmgmt scp list

Example Response

{
    "skip": 0,
    "limit": 10,
    "total": 1,
    "resources": [
        {
            "name": "scp-conn",
            "id": "55ffad19-8c7c-4a33-8fc6-d2d2bca5deb5",
            "uri": "kylo:kylo:connectionmgmt:connections:scp-conn-55ffad19-8c7c-4a33-8fc6-d2d2bca5deb5",
            "account": "kylo:kylo:admin:accounts:kylo",
            "createdAt": "2021-06-07T06:17:01.343933Z",
            "updatedAt": "2021-06-07T06:17:01.342893Z",
            "service": "scp",
            "category": "external-server",
            "products": [
                "backup/restore"
            ],
            "last_connection_ok": null,
            "last_connection_at": "0001-01-01T00:00:00Z",
            "host": "8.8.8.8",
            "port": 22,
            "username": "admin",
            "auth_method": "password",
            "public_key": "public-key",
            "path_to": "/home/scp"
        }
    ]
}

Testing an Existing SCP Connection

To test an existing SCP connection, run;

Syntax

ksctl connectionmgmt scp test --id <Connection-Name/ID> 

Example Request

ksctl connectionmgmt scp test --id scp-conn 

Example Response

{
    "connection_ok": true
}

Testing a New SCP Connection

To test a new SCP connection, run;

Syntax

ksctl connectionmgmt scp test --host <hostname> --scp-port <Port> --username <SCP-Connection-Username> --auth-method <Key or Password> --conn-password <SCP-Connection-Password> --path-to <Destination-Machine-Path> --public-key <key>

Example Request

ksctl connectionmgmt scp test --host 8.8.8.8 --scp-port 22 --username admin --auth-method password --conn-password paswd --public-key key --path-to "/home/scp"

Example Response

{
    "connection_ok": true
}