3. SSH鍵の作成 (handson-cli-conf)¶
作業の目的 [why]¶
SSH鍵"handson-cli-conf"をパスフレーズ無しで作成します。
完了条件/事前条件 [設計者用情報]
完了条件 [after]
主処理は、以下を満たしたときに成功したものとします。
- 完了条件1
- SSH秘密鍵ファイル"${HOME}/.ssh/handson-cli-conf"が存在する。
- 完了条件2
- SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-conf.pub"が存在する。
事前条件 [before]
主処理の実施は、以下の状態であることを前提とします。
- 事前条件1
- OpenSSH用ディレクトリ"${HOME}/.ssh"が存在する。
- 事前条件2
- SSH秘密鍵ファイル"${HOME}/.ssh/handson-cli-conf"が存在しない。
- 事前条件3
- SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-conf.pub"が存在しない。
作業対象 [what]¶
- OpenSSH環境
標準時間(合計)¶
8分
パラメータ設定¶
| パラメータ設定の標準時間: | 2分 |
|---|
作業に必要なモノ・情報 [resource]¶
作業開始には、以下が全て揃っていることが必要です。
リソース1: OpenSSH用ディレクトリ
- 今回は"${HOME}/.ssh"をOpenSSH用ディレクトリとします。
ディレクトリが存在することを確認します。
コマンド:
ls -d ${HOME}/.ssh
結果(例:存在する場合):
${HOME}/.ssh注釈
存在しない場合は作成します。
コマンド:
mkdir -p ${HOME}/.sshモード600に変更します。
コマンド:
chmod 600 ${HOME}/.ssh
リソース2: SSH鍵名
- 作成するSSH鍵の名称です。
- 今回は"handson-cli-conf"とします。
リソース3: SSH鍵ビット数
- 作成するSSH鍵のビット数です。
- 今回は"2048"とします。
リソース4: SSH鍵タイプ
- 作成するSSH鍵のタイプです。
- 今回は"rsa"とします。
リソース5: SSH鍵コメント
- 作成するSSH鍵のコメントです。
- 今回は"ssh key for handson-cli-conf"とします。
リソース6: SSH公開鍵ファイル
- 作成するSSH鍵の秘密鍵ファイルです。
- 今回は"${HOME}/.ssh/handson-cli-conf"とします。
リソース7: SSH秘密鍵ファイル
- 作成するSSH鍵の公開鍵ファイルです。
- 今回は"${HOME}/.ssh/handson-cli-conf.pub"とします。
パラメータの指定¶
作業に必要なパラメータを変数に格納をします。
0.6. SSH秘密鍵ファイルの指定¶
SSH鍵秘密鍵を指定します。
SSH秘密鍵ファイルを指定します。
変数の設定:
FILE_SSH_KEY_SECRET="${DIR_SSH}/${OPENSSH_KEY_NAME}" \ && echo ${FILE_SSH_KEY_SECRET}
結果(例):
${HOME}/.ssh/handson-cli-conf
0.7. SSH公開鍵ファイルの指定¶
SSH鍵公開鍵を指定します。
SSH公開鍵ファイルを指定します。
変数の設定:
FILE_SSH_KEY_PUBLIC="${DIR_SSH}/${OPENSSH_KEY_NAME}.pub" \ && echo ${FILE_SSH_KEY_PUBLIC}
結果(例):
${HOME}/.ssh/handson-cli-conf.pub
パラメータの保存¶
設定されている変数の保存先となるファイル名を指定します。
変数の設定:
DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-conf-codecommit" FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-openssh-key-create.env" \ && echo ${FILE_PARAMETER}
結果(例):
${HOME}/tmp/parameter-handson-cli-conf-codecommit/2019-07-09-openssh-key-create.env
各変数に正しいパラメータ値が格納されていることを確認しながら保存します。
変数の確認:
cat << EOF > ${FILE_PARAMETER} # 0.1. DIR_SSH:"${HOME}/.ssh" DIR_SSH="${DIR_SSH}" # 0.2. OPENSSH_KEY_NAME:"handson-cli-conf" OPENSSH_KEY_NAME="${OPENSSH_KEY_NAME}" # 0.3. SSH_KEY_BITS:"2048" SSH_KEY_BITS="${SSH_KEY_BITS}" # 0.4. SSH_KEY_TYPE:"rsa" SSH_KEY_TYPE="${SSH_KEY_TYPE}" # 0.5. SSH_KEY_COMMENT:"ssh key for handson-cli-conf" SSH_KEY_COMMENT="${SSH_KEY_COMMENT}" # 0.6. FILE_SSH_KEY_SECRET:"${HOME}/.ssh/handson-cli-conf" FILE_SSH_KEY_SECRET="${FILE_SSH_KEY_SECRET}" # 0.7. FILE_SSH_KEY_PUBLIC:"${HOME}/.ssh/handson-cli-conf.pub" FILE_SSH_KEY_PUBLIC="${FILE_SSH_KEY_PUBLIC}" EOF cat ${FILE_PARAMETER}
下段の変数が入っていない、もしくは上段と同等の値が入っていない場合は、それぞれの手順番号に戻って変数の設定を行います。
タスクの実施¶
| タスク標準時間: | 6分 |
|---|
1. 前処理¶
処理対象の状態確認¶
主処理の実施は、以下の状態であることを前提とします。
前提と異なることが判明した場合、直ちに処理を中止します。
事前条件1: OpenSSH用ディレクトリ"${HOME}/.ssh"が存在する。
「OpenSSH用ディレクトリ"${HOME}/.ssh"が存在する。」ことを確認します。
コマンド:
ls -d ${DIR_SSH}
結果(例):
${HOME}/.ssh
事前条件2: SSH秘密鍵ファイル"${HOME}/.ssh/handson-cli-conf"が存在しない。
「SSH秘密鍵ファイル"${HOME}/.ssh/handson-cli-conf"が存在しない。」ことを確認します。
コマンド:
! ls ${FILE_SSH_KEY_SECRET}
結果(例):
ls: ${HOME}/.ssh/handson-cli-conf No such file or directory
事前条件3: SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-conf.pub"が存在しない。
「SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-conf.pub"が存在しない。」ことを確認します。
コマンド:
! ls ${FILE_SSH_KEY_PUBLIC}
結果(例):
ls: ${HOME}/.ssh/handson-cli-conf.pub No such file or directory
2. 主処理¶
SSH鍵の作成¶
変数の確認:
cat << ETX # SSH_KEY_BITS:"2048" SSH_KEY_BITS="${SSH_KEY_BITS}" # SSH_KEY_TYPE:"rsa" SSH_KEY_TYPE="${SSH_KEY_TYPE}" # SSH_KEY_COMMENT:"ssh key for handson-cli-conf" SSH_KEY_COMMENT="${SSH_KEY_COMMENT}" # FILE_SSH_KEY_SECRET:"${HOME}/.ssh/handson-cli-conf" FILE_SSH_KEY_SECRET="${FILE_SSH_KEY_SECRET}" ETX
コマンド:
ssh-keygen \ -b ${SSH_KEY_BITS} \ -t ${SSH_KEY_TYPE} \ -N '' \ -C "${SSH_KEY_COMMENT}" \ -f ${FILE_SSH_KEY_SECRET}
結果(例):
Generating public/private rsa key pair. Your identification has been saved in ${HOME}/.ssh/handson-cli-conf. Your public key has been saved in ${HOME}/.ssh/handson-cli-conf.pub. The key fingerprint is: SHA256:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx handson-cli-conf The key's randomart image is: +---[RSA 2048]----+ | ....+++ ..oo+ .| |. ..ooo .E. =.= | |. oB. ... ..o.+ | |.o+.o . +o . | |.oo o.+ S . .o | |. .+ = * . o | | . o o o . . . o| | . . . . | | | +----[SHA256]-----+
3. 後処理¶
完了条件の確認¶
主処理は、以下を満たしたときに成功したものとします。
完了条件1: SSH秘密鍵ファイル"${HOME}/.ssh/handson-cli-conf"が存在する。
「SSH秘密鍵ファイル"${HOME}/.ssh/handson-cli-conf"が存在する。」ことを確認します。
コマンド:
ls ${FILE_SSH_KEY_SECRET}
結果(例):
${HOME}/.ssh/handson-cli-conf
完了条件2: SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-conf.pub"が存在する。
「SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-conf.pub"が存在する。」ことを確認します。
コマンド:
ls ${FILE_SSH_KEY_PUBLIC}
結果(例):
${HOME}/.ssh/handson-cli-conf.pub