トークン

服屋のショッピングモールを作ったと考えてみてください。コンテンツスタジオに登録しておいた商品を、お客様が見るショッピングサイト側で読み込んで表示したいとします。ところが、そのサイトは人ではなくプログラムです。人のようにIDとパスワードでログインすることはできません。こうしたとき、人の代わりにサイトやプログラムがコンテンツへアクセスできるように発行する秘密の鍵がトークンです。

トークンは錠前を開ける一本の鍵だと考えてください。この鍵を持つ側は、ログインなしでも決められた範囲の中でコンテンツを扱えます。そのためトークンはパスワードとまったく同じように扱う必要があります。誰にでも見せてはならず、漏れてしまうと手にした人がその権限をそのまま使えてしまいます。

WEEGLOOには、用途の異なる二種類の鍵があります。一つはアカウントに結びついた強力な鍵(Personal Access Token)で、もう一つは公開サイトにコンテンツを読み出して届けるための狭い鍵(Delivery Access Token)です。このページでは、二つの鍵がそれぞれ何で、いつ使うのかを見たうえで、コンテンツスタジオで実際に発行してみます。

二つの鍵は用途が異なります

まず、両者の違いをひと目で整理すると次のとおりです。

要点はこうです。Personal Access Tokenは一人の人を代わりに務める万能鍵に近く、Delivery Access Tokenは「玄関前の掲示板だけを見られる」狭い鍵です。用途が重ならないので、やりたいことに合うほうを選べば大丈夫です。

アカウントに結びついた鍵: Personal Access Token

Personal Access Tokenは、発行したアカウント本人に結びつく鍵です。この鍵を使うと、そのアカウントがコンテンツスタジオでできることを、ログインなしでそのまま行えます。商品を登録したり、修正したり、公開したりする管理作業まで可能です。

そのため、この鍵は強力です。たとえば毎晩自動で新商品をコンテンツスタジオにアップしてくれるプログラムを作るなら、そのプログラムは人のようにログインできないので、この鍵を渡します。サーバーや自動化スクリプトのように、人の目に直接触れない場所で管理作業を自動で回すときに使う鍵です。

強力なぶん、扱いには注意が必要です。この鍵は、お客様が見る公開Webサイトやブラウザに入れてはいけません。公開された場所に入れると誰でも鍵を取り出して見られてしまい、その鍵を手に入れた人は発行したアカウントの権限をそのまま使えてしまうからです。公開サイトで商品を読み込んで表示するだけのときは、この強力な鍵ではなく、下記のDelivery Access Tokenを使います。

Personal Access Tokenは、発行するときに名前を決めるだけで済みます。権限の範囲は別途選びません。発行したアカウントが持つ権限をそのまま受け継ぐからです。

Spaceに結びついた鍵: Delivery Access Token

Delivery Access Tokenは、特定の一つのSpaceに結びつく読み取り専用の鍵です。この鍵では、そのSpaceの中でPublished(公開)状態のコンテンツを読み出すことだけができます。公開していないDraft状態のコンテンツはこの鍵では読み取れず、修正したり削除したりすることもできません。

お客様が見るショッピングサイトが商品を読み込んで表示するときに使う鍵が、まさにこれです。サイトは商品を表示するだけで、登録したり消したりする必要はないので、読み取りだけができる狭い鍵で十分です。この鍵が漏れたとしても、公開されたコンテンツが読まれるだけで、コンテンツを壊すことはできません。

コンテンツを公開(Published)するとはどういうことか、そして公開して初めて外部に届けられる理由は状態と公開で扱います。

狭い役割を結びつけて読み取れる範囲を制限してください

Delivery Access Tokenを発行するときは、この鍵がどこまで読み取れるかをSpaceRole(役割)で定めて一緒に結びつけます。役割は「何を、どの操作までできるか」を定めておいた権限の束です。鍵に役割を結びつけると、その鍵は結びつけた役割が許す分だけ読み取れます。

ショッピングサイトなら「商品」だけ読めればよいので、商品(Content)に対してReadだけを許す狭い役割を作って結びつけます。そうすれば、この鍵が漏れたとしても商品情報だけが読まれるだけで、ほかのコンテンツやメンバー情報まで漏れることはありません。

すべてを扱えるAdministrator役割は結びつけないでください。AdministratorはそのSpaceの中のすべてを扱える最高権限の役割です。読み取りだけで済む公開サイト用の鍵にこれほど広い権限を結びつけると、鍵が漏れたときの危険が大きくなります。必要なものだけ読めるように狭めた役割を別に作って結びつけるのが安全です。

役割を作って権限を狭める方法は役割と権限で扱います。公開サイト用の鍵に結びつける、商品のReadだけを許す役割を、そのページを見てあらかじめ作っておいてください。

発行した秘密の値を扱う

どちらの鍵も、発行を終えると画面に秘密のトークン値が現れます。この値こそが鍵そのものです。サーバーやサイトに入れるときにこの値を使います。発行直後にその場でコピーして保管してください。トークンの詳細画面で改めて確認することもできます。

ただし、二つの鍵は置く場所が異なります。

• Personal Access Tokenはパスワードのように扱ってください。強力な鍵なのでサーバーの中だけに置き、お客様が見る公開サイトやブラウザ、他人が見られるコードには入れないでください。
• Delivery Access Tokenは逆に、お客様が見る公開サイトに入れるのが本来の用途です。サイトを開く人は誰でもこの値を見られることになりますが、狭い役割を結びつけてあるので、誰がこの値を持っていってもその役割が許した読み取りの範囲の外では何もできません。だからサイトに入れておくこと自体は問題になりません。ただし、使いたいサイトの外へむやみに広めないでください。

鍵をなくしたり、意図と違う使われ方をしているようであれば、その鍵を消して新しく発行し、差し替えればよいです。

Personal Access Token を発行する

毎晩新商品を自動でアップしてくれるプログラムに渡すPersonal Access Tokenを発行してみます。

1. アカウント設定でPersonal Access Tokenの画面を開いてください。
2. 右上の作成ボタンを押してください。
3. 名前欄に夜間 新商品アップロードを入力してください。この名前は、後でどんな用途で作った鍵かを見分けるためのものです。
4. 保存ボタンを押して発行してください。

発行が終わると秘密のトークン値が画面に現れます。その場でコピーして安全な場所に保管してください。画面の見た目は、下記のDelivery Access Tokenの発行結果と同じです。

Delivery Access Token を発行する

今度は、ショッピングサイトが商品を読み込んで表示するときに使うDelivery Access Tokenを発行してみます。この鍵は服屋のSpaceに結びつき、商品を読み取れる狭い役割も一緒に結びつけます。

まず、この鍵に結びつける役割がSpaceになければなりません。商品(Content)に対してReadだけを許す役割を役割と権限であらかじめ作っておいてください。以下では、その役割を商品 読み取り専用という名前で作っておいたものとします。

1. 服屋のSpaceの設定でDelivery Access Tokenの画面を開いてください。
2. 右上の作成ボタンを押してください。
3. 名前欄にショッピングサイト 配信用を入力してください。
4. 説明欄には、この鍵をどこで使うのかを書いておけます。(任意です。)
5. Space Roleで商品 読み取り専用を選んでください。Administratorは選ばないでください。
6. 作成ボタンを押して発行してください。

発行が終わると秘密のトークン値が画面に現れます。その場でコピーして安全な場所に保管してください。

もう使わない鍵は消してください

使わなくなった鍵はそのままにせず、消すのが安全です。トークン一覧からもう使わない鍵を見つけて消してください。鍵を消すと、その鍵ではもうアクセスできなくなります。鍵が漏れたようなときも同じです。疑わしい鍵を消して新しく発行し、差し替えればよいです。

次にすること

• 役割と権限: Delivery Access Tokenに結びつける、読み取り範囲を狭めた役割を作ります。
• 状態と公開: Delivery Access Tokenで読まれるのはPublished状態のコンテンツだけです。公開とは何かを学びます。
• API リファレンス: プログラムからトークンを直接発行したり、コンテンツを読み込んだりするときに必要な、リクエスト形式のような技術仕様を扱います。