View source for Automation in the context of multifactor authentication

<languages />
<translate>

<!--T:1-->
Automated workflows which connect to the clusters without human intervention cannot make use of a second authentication factor. In order to execute such workflows after MFA becomes a requirement, you must request access to one of our special nodes. These nodes will not require the use of a second factor, but will be otherwise much more limited than regular login nodes in terms of the type of authentication they accept and the type of action that they can be used to perform.

= Increased security measures = <!--T:2-->
== Available only by request ==
Users who need to make use of automated workflows for their research must first contact our [[technical support]] to be allowed to use these nodes. When contacting us, please explain in detail the type of automation you intend to use as part of your workflow. Tell us what commands will be executed and what tools or libraries you will be using to manage the automation.

== Available only through constrained SSH keys == <!--T:3-->
The only accepted means of authentication for the automation nodes will be through [[SSH_Keys#Using_CCDB|SSH keys uploaded to the CCDB]]. SSH keys written in your <i>.ssh/authorized_keys</i> file are not accepted. In addition, the SSH keys <b>must</b> obey the following constraints.  

=== <code>restrict</code> === <!--T:4-->
This constraint disables port forwarding, agent forwarding, and X11 forwarding. It also disables the pseudo teletype (PTY), blocking most interactive workloads. This is required because these automation nodes are not intended to be used to start long-running or interactive processes. Regular login nodes must be used instead. 

=== <code>from="pattern-list"</code> === <!--T:5-->
This constraint specifies that the key can only be used from IP addresses that match the patterns. This is to ensure that this key is not used from computers other than the ones intended. The patterns list must include only IP addresses that fully specify at least the network class, the network, and the subnet, which are the first three elements of an IP address, for example, <code>x.y.*.*</code> would not be accepted, but <code>x.y.z.*</code> would be accepted. Note that the IP address should be a ''public'' IP address, thus anything like <code>10.0.0.0 – 10.255.255.255</code>, <code>172.16.0.0 – 172.31.255.255</code> and <code>192.168.0.0 – 192.168.255.255</code> would be incorrect. You can use a site like [https://whatismyipaddress.com/ What Is My IP Address?] or the shell command <code>curl ifconfig.me</code> to learn your public IP address.

=== <code>command="COMMAND"</code> === <!--T:6-->
This constraint forces the command <code>COMMAND</code> to be executed when the connection is established. This is so that you may restrict which commands can be used with this key. 

== Convenience wrapper scripts to use for <code>command=</code> == <!--T:7-->
<code>command</code> constraints can specify any command, but they are most useful when using a wrapper script which will accept or reject commands based on which command is being called. You can write your own script, but for convenience, we provide a number of such scripts which allow common actions. These scripts are defined in [https://github.com/ComputeCanada/software-stack-custom/tree/main/bin/computecanada/allowed_commands this git repository].

<!--T:8-->
* <code>/cvmfs/soft.computecanada.ca/custom/bin/computecanada/allowed_commands/transfer_commands.sh</code> allows only file transfers, such as <code>scp</code>, <code>sftp</code> or <code>rsync</code>.
* <code>/cvmfs/soft.computecanada.ca/custom/bin/computecanada/allowed_commands/archiving_commands.sh</code> allows commands to archive files, such as <code>gzip</code>, <code>tar</code> or <code>dar</code>.
* <code>/cvmfs/soft.computecanada.ca/custom/bin/computecanada/allowed_commands/file_commands.sh</code> allows commands to manipulate files, such as <code>mv</code>, <code>cp</code> or <code>rm</code>.
* <code>/cvmfs/soft.computecanada.ca/custom/bin/computecanada/allowed_commands/git_commands.sh</code> allows the <code>git</code> command.
* <code>/cvmfs/soft.computecanada.ca/custom/bin/computecanada/allowed_commands/slurm_commands.sh</code> allows some Slurm commands, such as <code>squeue</code>, <code>sbatch</code>.
* <code>/cvmfs/soft.computecanada.ca/custom/bin/computecanada/allowed_commands/allowed_commands.sh</code> allows all of the above.

== Examples of accepted SSH keys == <!--T:9-->
Accepted SSH keys must include all 3 of the above constraints to be accepted. Here are examples of SSH keys that would be accepted: 
For example, the following key would be accepted, and could only be used for transferring files (through <code>scp</code>, <code>sftp</code> or <code>rsync</code> for example): 
<pre>
restrict,from="216.18.209.*",command="/cvmfs/soft.computecanada.ca/custom/bin/computecanada/allowed_commands/transfer_commands.sh" ssh-ed25519 AAAAC3NzaC1lZDI1NTE6AACAIExK9iTTDGsyqKKzduA46DvIJ9oFKZ/WN5memqG9Invw
</pre>
while this one would only allow Slurm commands (squeue, scancel, sbatch, scontrol, sq):  
<pre>
restrict,from="216.18.209.*",command="/cvmfs/soft.computecanada.ca/custom/bin/computecanada/allowed_commands/slurm_commands.sh" ssh-ed25519 AAAAC3NzaC1lZDI1NTE6AACAIExK9iTTDGsyqKKzduA46DvIJ9oFKZ/WN5memqG9Invw
</pre>

<!--T:16-->
{{Warning|title=Warning|content=
The constraints must be added directly as text in front of your key, before uploading the complete string in [https://ccdb.alliancecan.ca/ssh_authorized_keys your account]. 
}}

= Automation nodes for each cluster = <!--T:13-->
Here is the hostname of the node to be used for unattended connections on each cluster: 
* Cedar: robot.cedar.alliancecan.ca
* Graham: robot.graham.alliancecan.ca
* Béluga: robot.beluga.alliancecan.ca
* Narval: robot.narval.alliancecan.ca
* Niagara: robot.niagara.alliancecan.ca    (you may also use robot1.niagara.alliancecan.ca or robot2.niagara.alliancecan.ca directly, one is the fallback for the other)

= Using the right key = <!--T:10-->
If you have multiple keys on your computer, you need to be careful to use the correct key. This is typically done by passing parameters to the command you are using. Below are a few examples. 

<!--T:11-->
With <code>ssh</code> or <code>scp</code>:
{{Command|ssh -i .ssh/private_key_to_use ...}}
{{Command|scp -i .ssh/private_key_to_use ...}}

<!--T:12-->
With <code>rsync</code>: 
{{Command|rsync -e "ssh -i .ssh/private_key_to_use" ...}}

<!--T:14-->
It's often much more convenient to put these parameters into your ~/.ssh/config file, so they get picked up by any ssh client invocation.  For instance:
 host robot
  hostname robot.cluster.alliancecan.ca
  user myrobot
  identityfile ~/.ssh/my-robot-key
  identitiesonly yes
  requesttty no

<!--T:15-->
this means that the following kinds of commands will do what you want:
{{Command|ssh robot /usr/bin/ls}}
{{Command|rsync -a datadir/a robot:scratch/testdata}}

= IPv4 vs IPv6 issue = <!--T:17-->

<!--T:18-->
When connecting to the robot node the SSH client on your computer may choose to use the '''IPv6 addressing''' over the older '''IPv4'''.
This seems to be more probably in Windows environment. 
If this is the case you have to make sure that the IP address mask you put in the <code>restrict,from=</code> field of the key
matches the type your computer will be using when connecting to the node.

<!--T:19-->
You can check your addresses using this web site: https://test-ipv6.com/ .

<!--T:20-->
* An IPv4 address would look like '''199.241.166.5'''.
* An IPv6 address could be similar to '''2620:123:7002:4::5'''.

<!--T:21-->
The possible problem is that if you put the IPv4 address mask, '''199.241.166.*''' into the CCDB SSH key, and 
your SSH client will be connecting the the robot node using IPv6 address, the source address will not match the mask in the key
and the key will not be accepted by the robot node. 

=== How to identify the problem === <!--T:22-->

<!--T:23-->
If you are having difficulties to make the SSH connection to a robot node working.
Try this test command:
 ssh -i ~/.ssh/automation_key -vvv username@robot.graham.alliancecan.ca "ls -l" 

<!--T:24-->
This command tries to connect to the robot node on Graham cluster and execute the <code>ls -l</code> command 
using the <code>~/.ssh/automation_key</code> SSH key.
Then it prints the list of files in your home directory on Graham to screen.

<!--T:25-->
This command will produce a lot of debug output due to the <code>-vvv</code> option (be Very Very Verbose).
Look for the '''Connecting to...''' message there.
If it says something like this:
 debug1: Connecting to robot.graham.alliancecan.ca [199.241.166.5] port 22.

<!--T:26-->
it means the IPv4 is being used.
If the message is similar to 
 debug1: Connecting to robot.graham.alliancecan.ca [2620:123:7002:4::5] port 22.

<!--T:27-->
then IPv6 is being used to make the connection.

=== Possible solutions === <!--T:28-->

<!--T:29-->
* You can make the SSH client to '''explicitly use either IPv4 or IPv6''' using the <code>-4</code> and <code>-6</code> options, respectively, to match the format you used for the key in CCDB.

<!--T:30-->
* You can try using an '''IP address instead of the name''' to point to the robot node. Using Graham example, try using the 
: <code>ssh -i ~/.ssh/automation_key -vvv username@199.241.166.5 "ls -l"</code>
: instead, to force SSH to use the IPv4 addresses.

<!--T:31-->
* You can try to '''disable the IPv6 addressing''' for your system, to make sure that only IPv4 is used.
: Currently, there should not be any negative impact on your system. However, Microsoft does not recommend this, and this should be your '''last resort''' method, if nothing else works.
: How to disable IPv6 will depend on your system and the operating system.

= Automation using Python and Paramiko = <!--T:32-->

<!--T:33-->
If you are using the [https://www.paramiko.org/index.html Paramiko Python module] to automate your workflow, this is how you can make it work with the robot nodes:
<source lang=python>
# ====================================================================================================
#! /usr/bin/env python3
# ====================================================================================================
import os
import paramiko
# ====================================================================================================

<!--T:34-->
key = paramiko.Ed25519Key.from_private_key_file("/home/username/.ssh/cc_allowed")

<!--T:35-->
user = "username"
host = "robot.graham.alliancecan.ca"

<!--T:36-->
ssh = paramiko.SSHClient()

<!--T:37-->
# If the host is not known, it is OK.
ssh.set_missing_host_key_policy(paramiko.AutoAddPolicy())

<!--T:38-->
ssh.connect(hostname=host, username=user, pkey=key)

<!--T:39-->
cmd = "ls -l"
stdin, stdout, stderr = ssh.exec_command(cmd)

<!--T:40-->
print("".join(stdout.readlines()))

<!--T:41-->
ssh.close()
# ====================================================================================================
</source>
This code connects to the robot node on '''Graham''' using an automation key specified in CCDB and 
executes the <code>ls -l</code> command to get the list of files.
Then prints the list to the screen.

<!--T:42-->
Note, that it is important to install '''paramiko''' with the
 $ pip install paramiko[all]

<!--T:43-->
command. This will make sure that the support for the '''Ed25519''' key type will also be installed.

</translate>