1. SSH鍵の作成 (handson-cli-ssm-parameter_store)

作業の目的 [why]

SSH鍵"handson-cli-ssm-parameter_store"を作成します。

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

完了条件 [after]

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

完了条件1
SSH秘密鍵ファイル"${HOME}/.ssh/handson-cli-ssm-parameter_store"が存在する。
完了条件2
SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-ssm-parameter_store.pub"が存在する。

事前条件 [before]

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

事前条件1
鍵ファイル用ディレクトリ"${HOME}/.ssh"が存在する。
事前条件2
SSH秘密鍵ファイル"${HOME}/.ssh/handson-cli-ssm-parameter_store"が存在しない。
事前条件3
SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-ssm-parameter_store.pub"が存在しない。

作業対象 [what]

  • OpenSSH環境

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: 鍵ファイル用ディレクトリ

  • 今回は"${HOME}/.ssh"を鍵ファイル用ディレクトリとします。

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

コマンド:

ls -d ${HOME}/.ssh

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

${HOME}/.ssh

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

コマンド:

mkdir -p ${HOME}/.ssh

パーミッションは700にします。

コマンド:

chmod 700 ${HOME}/.ssh

リソース2: SSH鍵名

  • 作成するSSH鍵の名称です。
  • 今回は"handson-cli-ssm-parameter_store"とします。

リソース3: SSH鍵ビット数

  • 作成するSSH鍵のビット数です。
  • 今回は"2048"とします。

リソース4: SSH鍵タイプ

  • 作成するSSH鍵のタイプです。
  • 今回は"rsa"とします。

リソース5: SSH鍵コメント

  • 作成するSSH鍵のコメントです。
  • 今回は"ssh key for handson-cli-ssm-parameter_store"とします。

リソース6: SSH鍵パスフレーズ

  • 作成するSSH鍵のパスフレーズです。
  • 今回は"JawsUgCliHandson"とします。

パラメータの指定

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

0.1. 鍵ファイルディレクトリの指定

変数の設定:

DIR_KEY="${HOME}/.ssh"

0.2. SSH鍵名の指定

SSH鍵名を指定します。

変数の設定:

OPENSSH_KEY_NAME='handson-cli-ssm-parameter_store'

0.3. SSH鍵ビット数の指定

SSH鍵ビット数を指定します。

変数の設定:

SSH_KEY_BITS='2048'

0.4. SSH鍵タイプの指定

SSH鍵タイプを指定します。

変数の設定:

SSH_KEY_TYPE='rsa'

0.5. SSH鍵コメントの指定

SSH鍵コメントを指定します。

変数の設定:

SSH_KEY_COMMENT='ssh key for handson-cli-ssm-parameter_store'

0.6. SSH鍵のパスフレーズの指定

SSH鍵のパスフレーズを指定します。

変数の設定:

SSH_KEY_PASSPHRASE='JawsUgCliHandson'

パラメータの保存

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

変数の設定:

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

結果(例):

${HOME}/tmp/parameter-handson-cli-ssm-parameter_store/2019-05-27-openssh-key-create.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.1. DIR_KEY:"${HOME}/.ssh"
         DIR_KEY="${DIR_KEY}"
  # 0.2. OPENSSH_KEY_NAME:"handson-cli-ssm-parameter_store"
         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-ssm-parameter_store"
         SSH_KEY_COMMENT="${SSH_KEY_COMMENT}"
  # 0.6. SSH_KEY_PASSPHRASE:"JawsUgCliHandson"
         SSH_KEY_PASSPHRASE="${SSH_KEY_PASSPHRASE}"

EOF
cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

1.1. 状態確認に必要な情報の取得

SSH秘密鍵ファイルの指定

SSH鍵秘密鍵を指定します。

変数の設定:

FILE_SSH_KEY_SECRET="${DIR_KEY}/${OPENSSH_KEY_NAME}" \
  && echo ${FILE_SSH_KEY_SECRET}

結果(例):

${HOME}/.ssh/handson-cli-ssm-parameter_store

SSH公開鍵ファイルの指定

SSH鍵公開鍵を指定します。

変数の設定:

FILE_SSH_KEY_PUBLIC="${DIR_KEY}/${OPENSSH_KEY_NAME}.pub" \
  && echo ${FILE_SSH_KEY_PUBLIC}

結果(例):

${HOME}/.ssh/handson-cli-ssm-parameter_store.pub

1.2. 処理対象の状態確認

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

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

事前条件1: 鍵ファイル用ディレクトリ"${HOME}/.ssh"が存在する。

「鍵ファイル用ディレクトリ"${HOME}/.ssh"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_KEY}

結果(例):

${HOME}/.ssh

事前条件2: SSH秘密鍵ファイル"${HOME}/.ssh/handson-cli-ssm-parameter_store"が存在しない。

「SSH秘密鍵ファイル"${HOME}/.ssh/handson-cli-ssm-parameter_store"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_SSH_KEY_SECRET}

結果(例):

ls: ${HOME}/.ssh/handson-cli-ssm-parameter_store No such file or directory

事前条件3: SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-ssm-parameter_store.pub"が存在しない。

「SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-ssm-parameter_store.pub"が存在しない。」ことを確認します。

コマンド:

! ls ${FILE_SSH_KEY_PUBLIC}

結果(例):

ls: ${HOME}/.ssh/handson-cli-ssm-parameter_store.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-ssm-parameter_store"
    SSH_KEY_COMMENT="${SSH_KEY_COMMENT}"
  # SSH_KEY_PASSPHRASE:"JawsUgCliHandson"
    SSH_KEY_PASSPHRASE="${SSH_KEY_PASSPHRASE}"
  # FILE_SSH_KEY_SECRET:"${HOME}/.ssh/handson-cli-ssm-parameter_store"
    FILE_SSH_KEY_SECRET="${FILE_SSH_KEY_SECRET}"

ETX

コマンド:

ssh-keygen \
  -b ${SSH_KEY_BITS} \
  -t ${SSH_KEY_TYPE} \
  -N ${SSH_KEY_PASSPHRASE} \
  -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-ssm-parameter_store.
Your public key has been saved in ${HOME}/.ssh/handson-cli-ssm-parameter_store.pub.
The key fingerprint is:
SHA256:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx handson-cli-ssm-parameter_store
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-ssm-parameter_store"が存在する。

「SSH秘密鍵ファイル"${HOME}/.ssh/handson-cli-ssm-parameter_store"が存在する。」ことを確認します。

コマンド:

ls ${FILE_SSH_KEY_SECRET}

結果(例):

${HOME}/.ssh/handson-cli-ssm-parameter_store

完了条件2: SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-ssm-parameter_store.pub"が存在する。

「SSH公開鍵ファイル"${HOME}/.ssh/handson-cli-ssm-parameter_store.pub"が存在する。」ことを確認します。

コマンド:

ls ${FILE_SSH_KEY_PUBLIC}

結果(例):

${HOME}/.ssh/handson-cli-ssm-parameter_store.pub

完了