7.2. OpenSSHホスト別設定ファイルの作成¶
作業の目的 [why]¶
OpenSSHのホスト別設定ファイルを作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- OpenSSH設定ファイル"${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com"が存在する。
- 完了条件2
- "git-codecommit.ap-northeast-1.amazonaws.com"にSSHアクセスすることができる。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- IAMユーザ"handson-cli-conf-user"が存在する。
- 事前条件2
- IAMユーザ"handson-cli-conf-user にSSH公開鍵が登録されている。
- 事前条件3
- SSH秘密鍵"${HOME}/.ssh/handson-cli-conf"が存在する。
- 事前条件4
- OpenSSH設定ファイル用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在する。
- 事前条件5
- OpenSSH設定ファイル"${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com"が存在しない。
作業対象 [what]¶
- OpenSSH環境
標準時間(合計)¶
8分
パラメータ設定¶
パラメータ設定の標準時間: | 2分 |
---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: IAMユーザ名
- SSH公開鍵を登録するIAMユーザの名称です。
- 今回は"handson-cli-conf-user"とします。
リソース2: SSH秘密鍵ファイル
- 登録するSSH公開鍵の対になる秘密鍵ファイルです。
- 今回は"${HOME}/.ssh/handson-cli-conf"とします。
リソース3: OpenSSH設定ファイル用ディレクトリ
- SSHの設定ファイルを保存しているディレクトリ名です。
- 今回は"${HOME}/.ssh/conf.d/hosts"とします。
リソース4: OpenSSH設定ファイル
- 作成するOpenSSH設定ファイルです。
- 今回は"${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.2. SSH秘密鍵ファイルの指定¶
変数の設定:
DIR_SSH="${HOME}/.ssh"
変数の設定:
OPENSSH_KEY_NAME='handson-cli-conf'
SSH秘密鍵ファイルを指定します。
変数の設定:
FILE_SSH_KEY_SECRET="${DIR_SSH}/${OPENSSH_KEY_NAME}" \ && echo ${FILE_SSH_KEY_SECRET}
結果(例):
${HOME}/.ssh/handson-cli-conf
0.3. OpenSSH設定ファイル用ディレクトリの指定¶
SSH設定用ディレクトリの("${HOME}/.ssh"からの)相対パスを指定します。
変数の設定:
STRING_PATH_SSH_CONFIG='conf.d/hosts'
SSH設定用ディレクトリ(絶対パス)を指定します。
変数の設定:
DIR_SSH_CONFIG="${DIR_SSH}/${STRING_PATH_SSH_CONFIG}" \ && echo ${DIR_SSH_CONFIG}
結果(例):
${HOME}/.ssh/conf.d/hosts
0.4. OpenSSH設定ファイルの指定¶
OpenSSH設定ファイルを指定します。
変数の設定:
FILE_SSH_CONFIG_HOST="${DIR_SSH_CONFIG}/git-codecommit.amazonaws.com" \ && echo ${FILE_SSH_CONFIG_HOST}
結果(例):
${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-conf-codecommit" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-openssh-config-create-expand-confd_host-iam.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-conf-codecommit/2019-07-09-openssh-config-create-expand-confd_host-iam.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.1. IAM_USER_NAME:"handson-cli-conf-user" IAM_USER_NAME="${IAM_USER_NAME}" # 0.2. FILE_SSH_KEY_SECRET:"${HOME}/.ssh/handson-cli-conf" FILE_SSH_KEY_SECRET="${FILE_SSH_KEY_SECRET}" # 0.3. DIR_SSH_CONFIG:"${HOME}/.ssh/conf.d/hosts" DIR_SSH_CONFIG="${DIR_SSH_CONFIG}" # 0.4. FILE_SSH_CONFIG_HOST:"${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com" FILE_SSH_CONFIG_HOST="${FILE_SSH_CONFIG_HOST}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
タスク標準時間: | 6分 |
---|
1. 前処理¶
1.1. 処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: IAMユーザ"handson-cli-conf-user"が存在する。
「IAMユーザ"handson-cli-conf-user"が存在する。」ことを確認します。
コマンド:
aws iam list-users \ --query "Users[?UserName == \`${IAM_USER_NAME}\`].UserName" \ --output text
結果(例):
handson-cli-conf-user
事前条件2: IAMユーザ"handson-cli-conf-user にSSH公開鍵が登録されている。
「IAMユーザ"handson-cli-conf-user にSSH公開鍵が登録されている。」ことを確認します。
コマンド:
aws iam list-ssh-public-keys \ --user-name ${IAM_USER_NAME} \ --query "SSHPublicKeys[?UserName == \`${IAM_USER_NAME}\`].SSHPublicKeyId" \ --output text
結果(例):
APKAxxxxxxxxxxxxxxxx
事前条件3: SSH秘密鍵"${HOME}/.ssh/handson-cli-conf"が存在する。
「SSH秘密鍵"${HOME}/.ssh/handson-cli-conf"が存在する。」ことを確認します。
コマンド:
ls ${FILE_SSH_KEY_SECRET}
結果(例):
${HOME}/.ssh/handson-cli-conf
事前条件4: OpenSSH設定ファイル用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在する。
「OpenSSH設定ファイル用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_SSH_CONFIG}
結果(例):
${HOME}/.ssh/conf.d/hosts
事前条件5: OpenSSH設定ファイル"${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com"が存在しない。
「OpenSSH設定ファイル"${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com"が存在しない。」ことを確認します。
コマンド:
! ls ${FILE_SSH_CONFIG_HOST}
結果(例):
ls: ${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com No such file or directory
1.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
2. 主処理¶
ホスト別設定ファイルの作成¶
変数の確認:
cat << ETX # IAM_SSH_PUBLIC_KEY_ID:"APKAxxxxxxxxxxxxxxxx" IAM_SSH_PUBLIC_KEY_ID="${IAM_SSH_PUBLIC_KEY_ID}" # FILE_SSH_KEY_SECRET:"${HOME}/.ssh/handson-cli-conf" FILE_SSH_KEY_SECRET="${FILE_SSH_KEY_SECRET}" # FILE_SSH_CONFIG_HOST:"${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com" FILE_SSH_CONFIG_HOST="${FILE_SSH_CONFIG_HOST}" ETX
コマンド:
cat << EOF >> ${FILE_SSH_CONFIG_HOST} Host git-codecommit.*.amazonaws.com User ${IAM_SSH_PUBLIC_KEY_ID} IdentityFile ${FILE_SSH_KEY_SECRET} EOF cat ${FILE_SSH_CONFIG_HOST}
結果(例):
Host git-codecommit.*.amazonaws.com User APKAxxxxxxxxxxxxxxxx IdentityFile ${HOME}/.ssh/handson-cli-conf
${HOME}/.ssh配下にファイルを作成したときは、所有者以外のアクセス権限を剥奪しておきます。
コマンド:
chmod go-rw ${FILE_SSH_CONFIG_HOST}
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: OpenSSH設定ファイル"${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com"が存在する。
「OpenSSH設定ファイル"${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com"が存在する。」ことを確認します。
コマンド:
ls ${FILE_SSH_CONFIG_HOST}
結果(例):
${HOME}/.ssh/conf.d/hosts/git-codecommit.amazonaws.com
完了条件2: "git-codecommit.ap-northeast-1.amazonaws.com"にSSHアクセスすることができる。
「"git-codecommit.ap-northeast-1.amazonaws.com"にSSHアクセスすることができる。」ことを確認します。
変数の設定:
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 \ | grep successfully注釈
以下が表示された場合は、'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.
注釈
以下の文字列が表示されていればSSHアクセスに成功しています。
You have successfully authenticated over SSH.