2. IAMユーザSSH公開鍵の登録 (handson-cli-codecommit-user)

作業の目的 [why]

IAMユーザ"handson-cli-codecommit-user"のSSH公開鍵を登録します。

完了条件/事前条件 [設計者用情報]

完了条件 [after]

主処理は、以下を満たしたときに成功したものとします。

完了条件1
IAMユーザ"handson-cli-codecommit-user"にSSH公開鍵が登録されている。

事前条件 [before]

主処理の実施は、以下の状態であることを前提とします。

事前条件1
SSH公開鍵"${HOME}/.ssh/id_rsa.pub"が存在する。
事前条件2
SSH秘密鍵"${HOME}/.ssh/id_rsa"が存在する。
事前条件3
IAMユーザ"handson-cli-codecommit-user にSSH公開鍵が登録されていない。

作業対象 [what]

  • IAMサービス

標準時間(合計)

8分

パラメータ設定

パラメータ設定の標準時間:2分

作業に必要なモノ・情報 [resource]

作業開始には、以下が全て揃っていることが必要です。

リソース1: SSH秘密鍵ファイル

  • 登録するSSH公開鍵の対になる秘密鍵ファイルです。
  • 今回は"${HOME}/.ssh/id_rsa"をSSH秘密鍵ファイルとします。

SSH秘密鍵ファイルが存在することを確認します。

コマンド:

ls ${HOME}/.ssh/id_rsa

結果(例:存在する場合):

${HOME}/.ssh/id_rsa

注釈

存在しない場合は作成します。

コマンド:

ssh-keygen -t rsa -b 2048

パスフレーズの設定は任意です。

リソース2: SSH公開鍵ファイル

  • 登録するSSH公開鍵ファイルです。
  • 今回は"${HOME}/.ssh/id_rsa.pub"とします。

リソース3: IAMユーザ名

  • SSH公開鍵を登録するIAMユーザの名称です。
  • 今回は"handson-cli-codecommit-user"とします。

リソース4: SSH設定ファイル用ディレクトリ

  • SSHの設定ファイルを保存するディレクトリ名です。
  • 今回は"${HOME}/.ssh/conf.d/hosts"をSSH設定ファイル用ディレクトリとします。

ディレクトリが存在することを確認します。

コマンド:

ls -d ${HOME}/.ssh/conf.d/hosts

結果(例:存在する場合):

${HOME}/.ssh/conf.d/hosts

注釈

存在しない場合は作成します。

コマンド:

mkdir -p ${HOME}/.ssh/conf.d/hosts

${HOME}/.ssh/config に以下の記述が存在しないか確認します。

${HOME}/.ssh/config:

Include conf.d/hosts/*

注釈

存在しない場合は、先頭行に追記します。

${HOME}/.ssh/config にファイル所有者以外に権限が存在しないことを確認します。

コマンド:

ls -l ${HOME}/.ssh/config | cut -d " " -f 1

結果(例):

-rw-------

(もしくは -r--------)

注釈

異なる場合は、モードを変更します。

コマンド:

chmod 600 ${HOME}/.ssh/config

パラメータの指定

作業に必要なパラメータを変数に格納をします。

0.1. SSH秘密鍵ファイルの指定

SSH秘密鍵ファイルを指定します。

変数の設定:

FILE_SSH_KEY_SECRET="${HOME}/.ssh/id_rsa"

0.2. SSH公開鍵ファイルの指定

SSH公開鍵ファイルを指定します。

変数の設定:

FILE_SSH_KEY_PUBLIC="${HOME}/.ssh/id_rsa.pub"

0.3. IAMユーザ名の指定

IAMユーザ名を指定します。

変数の設定:

IAM_USER_NAME='handson-cli-codecommit-user'

パラメータの保存

設定されている変数の保存先となるファイル名を指定します。

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-iam-ssh_public_key-create.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli/2019-04-30-iam-ssh_public_key-create.env

各変数に正しいパラメータ値が格納されていることを確認しながら保存します。

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.1. FILE_SSH_KEY_SECRET:"${HOME}/.ssh/id_rsa"
         FILE_SSH_KEY_SECRET="${FILE_SSH_KEY_SECRET}"
  # 0.2. FILE_SSH_KEY_PUBLIC:"${HOME}/.ssh/id_rsa.pub"
         FILE_SSH_KEY_PUBLIC="${FILE_SSH_KEY_PUBLIC}"
  # 0.3. IAM_USER_NAME:"handson-cli-codecommit-user"
         IAM_USER_NAME="${IAM_USER_NAME}"

EOF
cat ${FILE_PARAMETER}

下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。

タスクの実施

タスク標準時間:6分

1. 前処理

処理対象の状態確認

主処理の実施は、以下の状態であることを前提とします。

前提と異なることが判明した場合、直ちに処理を中止します。

事前条件1: SSH公開鍵"${HOME}/.ssh/id_rsa.pub"が存在する。

「SSH公開鍵"${HOME}/.ssh/id_rsa.pub"が存在する。」ことを確認します。

コマンド:

ls ${FILE_SSH_KEY_SECRET}

結果(例):

${HOME}/.ssh/id_rsa

事前条件2: SSH秘密鍵"${HOME}/.ssh/id_rsa"が存在する。

「SSH秘密鍵"${HOME}/.ssh/id_rsa"が存在する。」ことを確認します。

コマンド:

ls ${FILE_SSH_KEY_PUBLIC}

結果(例):

${HOME}/.ssh/id_rsa.pub

事前条件3: IAMユーザ"handson-cli-codecommit-user にSSH公開鍵が登録されていない。

「IAMユーザ"handson-cli-codecommit-user にSSH公開鍵が登録されていない。」ことを確認します。

コマンド:

aws iam list-ssh-public-keys \
  --user-name ${IAM_USER_NAME} \
  --query "SSHPublicKeys[?UserName == \`${IAM_USER_NAME}\`].SSHPublicKeyId" \
  --output text

結果(例):

(出力なし)

2. 主処理

公開鍵のアップロード

変数の確認:

cat << ETX

  # IAM_USER_NAME:"handson-cli-codecommit-user"
    IAM_USER_NAME="${IAM_USER_NAME}"
  # FILE_SSH_KEY_PUBLIC:"${HOME}/.ssh/id_rsa.pub"
    FILE_SSH_KEY_PUBLIC="${FILE_SSH_KEY_PUBLIC}"

ETX

コマンド:

aws iam upload-ssh-public-key \
  --user-name ${IAM_USER_NAME} \
  --ssh-public-key-body file://${FILE_SSH_KEY_PUBLIC}

結果(例):

{
  "SSHPublicKey": {
    "UserName": "lab-office",
    "Status": "Active",
    "SSHPublicKeyBody": "ssh-rsa AAAABxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx handson-cli-codecommit-user@hostname.localn",
    "UploadDate": "2019-04-30T01:23:45.678Z",
    "Fingerprint": "xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx",
    "SSHPublicKeyId": "APKAxxxxxxxxxxxxxxxx"
  }
}

3. 後処理

3.1. 完了条件の確認

主処理は、以下を満たしたときに成功したものとします。

完了条件1: IAMユーザ"handson-cli-codecommit-user"にSSH公開鍵が登録されている。

「IAMユーザ"handson-cli-codecommit-user"にSSH公開鍵が登録されている。」ことを確認します。

コマンド:

aws iam list-ssh-public-keys \
  --user-name ${IAM_USER_NAME} \
  --query "SSHPublicKeys[?UserName == \`${IAM_USER_NAME}\`].SSHPublicKeyId" \
  --output text

結果(例):

APKAxxxxxxxxxxxxxxxx

3.2. 追加作業 (任意)

SSH公開鍵IDの取得

コマンド:

IAM_SSH_PUBLIC_KEY_ID=$( \
  aws iam list-ssh-public-keys \
    --user-name ${IAM_USER_NAME} \
    --query "SSHPublicKeys[?UserName == \`${IAM_USER_NAME}\`].SSHPublicKeyId" \
    --output text \
) \
  && echo ${IAM_SSH_PUBLIC_KEY_ID}

結果(例):

APKAxxxxxxxxxxxxxxxx

アクセス情報の登録

変数の確認:

cat << ETX

  # IAM_SSH_PUBLIC_KEY_ID:"APKAxxxxxxxxxxxxxxxx"
    IAM_SSH_PUBLIC_KEY_ID="${IAM_SSH_PUBLIC_KEY_ID}"
  # FILE_SSH_KEY_SECRET:"${HOME}/.ssh/id_rsa"
    FILE_SSH_KEY_SECRET="${FILE_SSH_KEY_SECRET}"

ETX

コマンド:

cat << EOF >> ${HOME}/.ssh/conf.d/hosts/handson-cli-git-codecommit.amazonaws.com
Host git-codecommit.*.amazonaws.com
  User ${IAM_SSH_PUBLIC_KEY_ID}
  IdentityFile ${FILE_SSH_KEY_SECRET}
EOF

cat ${HOME}/.ssh/conf.d/hosts/handson-cli-git-codecommit.amazonaws.com

結果(例):

Host git-codecommit.*.amazonaws.com
  User APKAxxxxxxxxxxxxxxxx
  IdentityFile ${HOME}/.ssh/id_rsa

${HOME}/.ssh配下にファイルを作成したときは、所有者以外のアクセス権限を剥奪しておきます。

コマンド:

chmod 600 ${HOME}/.ssh/conf.d/hosts/handson-cli-git-codecommit.amazonaws.com

アクセス確認

変数の設定:

export AWS_DEFAULT_REGION="ap-northeast-1"

変数の確認:

cat << ETX

  # AWS_DEFAULT_REGION:"ap-northeast-1"
    AWS_DEFAULT_REGION="${AWS_DEFAULT_REGION}"

ETX

コマンド:

ssh git-codecommit.${AWS_DEFAULT_REGION}.amazonaws.com

注釈

以下が表示された場合は、'yes'と入力して、エンターキーを押します。

The authenticity of host 'git-codecommit.ap-northeast-1.amazonaws.com (xxx.xxx.xxx.xxx)' can't be established.
RSA key fingerprint is xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx.
Are you sure you want to continue connecting (yes/no)?

結果(例):

Warning: Permanently added 'git-codecommit.ap-northeast-1.amazonaws.com,52.119.220.10' (RSA) to the list of known hosts.

結果(例):

You have successfully authenticated over SSH. You can use Git to interact with AWS CodeCommit. Interactive shells are not supported.Connection to git-codecommit.ap-northeast-1.amazonaws.com closed by remote host.
Connection to git-codecommit.ap-northeast-1.amazonaws.com closed.

完了