7.1. OpenSSH 設定ファイルの更新 (ホスト別対応)

作業の目的 [why]

OpenSSHの設定ファイルに、ホスト別設定を追加します。

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

完了条件 [after]

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

完了条件1
OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在する。

事前条件 [before]

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

事前条件1
OpenSSH confgファイル"${HOME}/.ssh/config"が存在する。
事前条件2
OpenSSH設定用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在する。
事前条件3
OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在しない。

作業対象 [what]

  • OpenSSH環境

標準時間(合計)

8分

パラメータ設定

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

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

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

リソース1: SSH configファイル

  • SSHクライアントの設定ファイルです。
  • 今回は"${HOME}/.ssh/config"をSSH configファイルとします。

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

コマンド:

ls ${HOME}/.ssh/config

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

${HOME}/.ssh/config

注釈

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

コマンド:

echo '# OpenSSH client config'   > ${HOME}/.ssh/config

ファイル所有者以外の読み取り権限を削除します。

コマンド:

chmod go-rw ${HOME}/.ssh/config

リソース2: 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

パラメータの指定

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

0.1. OpenSSH confgファイル名の指定

変数の設定:

DIR_SSH="${HOME}/.ssh"

OpenSSH confgファイル名を指定します。

変数の設定:

FILE_SSH_CONFIG="${DIR_SSH}/config" \
  && echo ${FILE_SSH_CONFIG}

結果(例):

${HOME}/.ssh/config

0.2. OpenSSH設定用ディレクトリの相対パスの指定

SSH設定用ディレクトリの("${HOME}/.ssh"からの)相対パスを指定します。

変数の設定:

STRING_PATH_SSH_CONFIG='conf.d/hosts'

0.3. OpenSSH設定用ディレクトリの絶対パスの指定

SSH設定用ディレクトリ(絶対パス)を指定します。

変数の設定:

DIR_SSH_CONFIG="${DIR_SSH}/${STRING_PATH_SSH_CONFIG}" \
  && echo ${DIR_SSH_CONFIG}

結果(例):

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

パラメータの保存

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

変数の設定:

DIR_PARAMETER="${HOME}/tmp/parameter-handson-cli-conf-codecommit"
FILE_PARAMETER="${DIR_PARAMETER}/$(date +%Y-%m-%d)-openssh-config-create-expand-confd-host.env" \
  && echo ${FILE_PARAMETER}

結果(例):

${HOME}/tmp/parameter-handson-cli-conf-codecommit/2019-07-09-openssh-config-create-expand-confd-host.env

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

変数の確認:

cat << EOF > ${FILE_PARAMETER}

  # 0.1. FILE_SSH_CONFIG:"${HOME}/.ssh/config"
         FILE_SSH_CONFIG="${FILE_SSH_CONFIG}"
  # 0.2. STRING_PATH_SSH_CONFIG:"conf.d/hosts"
         STRING_PATH_SSH_CONFIG="${STRING_PATH_SSH_CONFIG}"
  # 0.3. DIR_SSH_CONFIG:"${HOME}/.ssh/conf.d/hosts"
         DIR_SSH_CONFIG="${DIR_SSH_CONFIG}"

EOF
cat ${FILE_PARAMETER}

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

タスクの実施

タスク標準時間:6分

1. 前処理

処理対象の状態確認

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

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

事前条件1: OpenSSH confgファイル"${HOME}/.ssh/config"が存在する。

「OpenSSH confgファイル"${HOME}/.ssh/config"が存在する。」ことを確認します。

コマンド:

ls ${FILE_SSH_CONFIG}

結果(例):

${HOME}/.ssh/config

事前条件2: OpenSSH設定用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在する。

「OpenSSH設定用ディレクトリ"${HOME}/.ssh/conf.d/hosts"が存在する。」ことを確認します。

コマンド:

ls -d ${DIR_SSH_CONFIG}

結果(例):

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

事前条件3: OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在しない。

「OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在しない。」ことを確認します。

OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在しないことを確認します。

コマンド:

! cat ${FILE_SSH_CONFIG} \
  | grep '^Include' \
  | grep "${STRING_PATH_SSH_CONFIG}"

結果(例):

(出力なし)

2. 主処理

OpenSSH configファイルの更新

変数の確認

cat << EOF

  # STRING_PATH_SSH_CONFIG:"conf.d/hosts"
    STRING_PATH_SSH_CONFIG="${STRING_PATH_SSH_CONFIG}"
  # FILE_SSH_CONFIG:"${HOME}/.ssh/config"
    FILE_SSH_CONFIG="${FILE_SSH_CONFIG}"

EOF

コマンド:

echo "Include ${STRING_PATH_SSH_CONFIG}/*" \
  >> ${FILE_SSH_CONFIG}

結果(例):

(出力なし)

3. 後処理

完了条件の確認

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

完了条件1: OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在する。

「OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在する。」ことを確認します。

OpenSSH confgファイル"${HOME}/.ssh/config"にディレクトリ"${HOME}/.ssh/conf.d/hosts"を対象としたインクルード文が存在しないことを確認します。

コマンド:

cat ${FILE_SSH_CONFIG} \
  | grep '^Include' \
  | grep "${STRING_PATH_SSH_CONFIG}"

結果(例):

Include conf.d/hosts/*

完了