5.3. SNSトピックの購読承認

作業の目的 [why]

SNSトピック"sesincoming-2017-10-09"へのメールアドレス"<通知先として登録するメールアドレス>"を承認します。

作業対象 [what]

  • SNSトピック

標準時間

8分

前提条件

作業権限条件 [who]

本作業は、以下の作業権限を有する人が行います。

作業権限条件: SNSへの権限

SNSに対してフル権限があること。

作業環境条件 [where]

本作業は、以下の作業環境で行います。

作業環境条件1: OSとバージョン

Amazon Linuxの以下のバージョンで動作確認済

コマンド:

cat /etc/issue | head -1

結果(例):

Amazon Linux AMI release 2016.09

作業環境条件2: シェルとバージョン

bashの以下のバージョンで動作確認済

コマンド:

bash --version -v | head -1

結果(例):

GNU bash, バージョン 4.2.46(1)-release (x86_64-redhat-linux-gnu)

作業環境条件3: AWS CLIのバージョン

以下のバージョンで動作確認済

  • AWS CLI 1.11.117

コマンド:

aws --version

結果(例):

aws-cli/1.11.166 Python/2.7.12 Linux/4.4.11-23.53.amzn1.x86_64 botocore/1.7.24

バージョンが古い場合は最新版に更新しましょう。

コマンド:

sudo -H pip install -U awscli

開始条件

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

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

リソース1: SNSトピック名

  • 購読するSNSトピックの名称です。
  • 今回は"sesincoming-2017-10-09"とします。

リソース2: 通知先エンドポイント

  • SNSトピックの通知先です。プロトコルemailの場合はメールアドレスとなります。
  • 今回は"<通知先として登録するメールアドレス>"とします。
  • 作業中に受信メールの文面をターミナルに貼り付けられる必要があります。

作業開始 [when]

以下を全て満たしているとき、作業を開始します。

  • 開始の指示があった場合。

タスクの実施

0. パラメータの指定

まず変数の確認をします。

変数の確認:

cat << ETX

  0.a. AWS_DEFAULT_PROFILE: actual: ${AWS_DEFAULT_PROFILE}
                            expect: <SNSのフル権限が許可されているプロファイル>
  0.b. AWS_DEFAULT_REGION:  actual: ${AWS_DEFAULT_REGION}
                            expect: ap-northeast-1

  0.1. SNS_TOPIC_NAME:      actual: ${SNS_TOPIC_NAME}
                            expect: sesincoming-2017-10-09
  0.2. SNS_NOTIF_ENDPOINT   actual: ${SNS_NOTIF_ENDPOINT}
                            expect: <通知先として登録するメールアドレス>
  0.3. SNS_CONFIRM_URL      actual: ${SNS_CONFIRM_URL}
                            expect: https://sns.ap-northeast-1.amazonaws.com/confirmation.html?TopicArn=arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09&Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&Endpoint=<通知先として登録するメールアドレス>

ETX

変数が入っていない、適切でない場合は、それぞれの手順番号について作業を行います。

0.a. プロファイルの指定

プロファイルの一覧を確認します。

コマンド:

cat ~/.aws/credentials \
 | grep '\[' \
 | sed 's/\[//g' | sed 's/\]//g'

結果(例):

iamFull-prjz-mbpr13
<SNSのフル権限が許可されているプロファイル>

変数の設定:

export AWS_DEFAULT_PROFILE='<SNSのフル権限が許可されているプロファイル>'

0.b. リージョンの指定

変数の設定

export AWS_DEFAULT_REGION='ap-northeast-1'

0.1. SNSトピック名の指定

SNSトピック名を指定します。

変数の設定:

SNS_TOPIC_NAME='sesincoming-2017-10-09'

0.2. 通知先エンドポイントの指定

通知先エンドポイントを指定します。

変数の設定:

SNS_NOTIF_ENDPOINT='<通知先として登録するメールアドレス>'

0.3. トークンURLの指定

登録したメールアドレス宛に "Subscription Confirmation"という表題のメールが届いているはずです。

Subscribeの承認に必要なトークンが、この通知に含まれています。 (SNSでは、エンドポイントへのConfirmation通知以外でトークンを取得することはできません。)

emailの場合、通知されてきたHTMLメールの'Confirm subscription'のリンク先のURLにトークン文字列が含まれています。

URL(例):

https://sns.ap-northeast-1.amazonaws.com/confirmation.html?TopicArn=arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09&Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&Endpoint=<通知先として登録するメールアドレス>

このURLをコピーして、変数に格納しましょう。 URLに&が含まれているので、値をシングルクォートで囲む必要があります。

変数の設定:

SNS_CONFIRM_URL='<Confirm subscriptionのリンク先URL>'

再確認

設定されている変数の内容を再確認します。

変数の確認:

cat << ETX

  0.a. AWS_DEFAULT_PROFILE: actual: ${AWS_DEFAULT_PROFILE}
                            expect: <SNSのフル権限が許可されているプロファイル>
  0.b. AWS_DEFAULT_REGION:  actual: ${AWS_DEFAULT_REGION}
                            expect: ap-northeast-1

  0.1. SNS_TOPIC_NAME:      actual: ${SNS_TOPIC_NAME}
                            expect: sesincoming-2017-10-09
  0.2. SNS_NOTIF_ENDPOINT   actual: ${SNS_NOTIF_ENDPOINT}
                            expect: <通知先として登録するメールアドレス>
  0.3. SNS_CONFIRM_URL      actual: ${SNS_CONFIRM_URL}
                            expect: https://sns.ap-northeast-1.amazonaws.com/confirmation.html?TopicArn=arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09&Token=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&Endpoint=<通知先として登録するメールアドレス>

ETX

1. 前処理

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

SNSトピックのARN取得

変数の設定:

SNS_TOPIC_ARN=$( \
  aws sns list-topics \
    --query "Topics[?contains(TopicArn, \`${SNS_TOPIC_NAME}\`)].TopicArn" \
    --output text \
) \
  && echo ${SNS_TOPIC_ARN}

結果(例):

arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09

1.2. 作業対象の状態確認

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

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

事前条件1: メールアドレス"<通知先として登録するメールアドレス>"がSNSトピック"sesincoming-2017-10-09"に購読者として登録されていない。

コマンド:

aws sns list-subscriptions-by-topic \
  --topic-arn ${SNS_TOPIC_ARN} \
  --query "Subscriptions[?Endpoint == \`${SNS_NOTIF_ENDPOINT}\`].SubscriptionArn"

結果(例):

[
    "PendingConfirmation"
]

事前条件2: メールアドレス"<通知先として登録するメールアドレス>"でメールを受信できる状態にある。

「メールアドレス"<通知先として登録するメールアドレス>"でメールを受信できる状態にある。」ことを確認します。

1.3. 主処理に必要な情報の取得

トークン文字列の取り出し

URLからトークンを取り出して変数に定義します。

変数の設定:

SNS_CONFIRM_TOKEN=$( \
  echo ${SNS_CONFIRM_URL} |\
  sed 's/^.*&Token=//' |\
  sed 's/&Endpoint.*$//' \
) \
  && echo ${SNS_CONFIRM_TOKEN}

トークン(例):

2336412f37fb687f5d51e6e241d638b114f4ea40797156d59440ce34e67a7253af4c0641c81e3c4984b032ada9b7fc14668a462c383e2fb12b21a42a974b9fd47646f03f3158413a00692d5ef277785a8b4dde345639236f8365dbf35df89e8bdd512c965c8da54adbb071a667528d5a

2. 主処理

Confirmationの実施

購読の承認を行います。

Tokenの値を知っている人のみがConfirmationを行うことができます。

ここでは、購読者自身がUnsubscribeできないようにするために、authenticate-on-unsubscribeオプションをtrueにします。

変数の確認:

cat << ETX

  SNS_TOPIC_ARN:     ${SNS_TOPIC_ARN}
                     arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09

  SNS_CONFIRM_TOKEN: ${SNS_CONFIRM_TOKEN}
                     xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

ETX

コマンド:

aws sns confirm-subscription \
  --topic-arn ${SNS_TOPIC_ARN} \
  --token ${SNS_CONFIRM_TOKEN} \
  --authenticate-on-unsubscribe true

結果(例):

{
  "SubscriptionArn": "arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

3. 後処理

完了条件の確認

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

完了条件1: メールアドレス"<通知先として登録するメールアドレス>"がSNSトピック"sesincoming-2017-10-09"に購読者として登録されている。

「メールアドレス"<通知先として登録するメールアドレス>"がSNSトピック"sesincoming-2017-10-09"に購読者として登録されている。」ことを確認します。

コマンド:

aws sns list-subscriptions-by-topic \
  --topic-arn ${SNS_TOPIC_ARN} \
  --query "Subscriptions[?Endpoint == \`${SNS_NOTIF_ENDPOINT}\`].SubscriptionArn"

結果(例):

{
    "SubscriptionArn": "arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

SubscriptionArnの値が、'pendingConfirmation'からARNに変わっているはずです。

参考

Subscription属性の確認

変数の設定:

SNS_SUBSCRIPTION_ARN=$( \
  aws sns list-subscriptions-by-topic \
    --topic-arn ${SNS_TOPIC_ARN} \
    --query "Subscriptions[?Endpoint == \`${SNS_NOTIF_ENDPOINT}\`].SubscriptionArn" \
    --output text \
) \
  && echo ${SNS_SUBSCRIPTION_ARN}

結果(例):

arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Subscriptionの属性を確認してみましょう。

コマンド:

aws sns get-subscription-attributes \
  --subscription-arn ${SNS_SUBSCRIPTION_ARN}

結果(例):

{
  "Attributes": {
    "Endpoint": "<通知先として登録するメールアドレス>",
    "Protocol": "email",
    "RawMessageDelivery": "false",
    "ConfirmationWasAuthenticated": "true",
    "Owner": "XXXXXXXXXXXX",
    "SubscriptionArn": "arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "TopicArn": "arn:aws:sns:ap-northeast-1:XXXXXXXXXXXX:sesincoming-2017-10-09"
  }
}

完了