これは、Classroom アドオンのチュートリアル シリーズの2 つ目のチュートリアルです。
このチュートリアルでは、ウェブ アプリケーションに Google ログインを追加します。これは、Classroom アドオンに必要な動作です。今後の API 呼び出しには、この認可フローの認証情報を使用します。
このチュートリアルでは、次の作業を行います。
- iframe 内でセッション データを維持するようにウェブアプリを構成する。
- Google OAuth 2.0 サーバー間ログイン フローを実装する。
- OAuth 2.0 API を呼び出します。
- API 呼び出しの承認、ログアウト、テストをサポートするために、追加のルートを作成します。
完了すると、ウェブアプリでユーザーを完全に承認し、Google API を呼び出すことができます。
承認フローを理解する
Google API では、認証と承認に OAuth 2.0 プロトコルを使用しています。Google の OAuth 実装の詳細については、Google Identity OAuth ガイドをご覧ください。
アプリケーションの認証情報は Google Cloud で管理されます。これらを作成したら、ユーザーの認証と承認を行う 4 つのステップのプロセスを実装します。
- 承認をリクエストします。このリクエストの一部としてコールバック URL を指定します。完了すると、承認 URL が届きます。
- ユーザーを認可 URL にリダイレクトします。表示されたページには、アプリに必要な権限がユーザーに通知され、アクセスを許可するよう求めるメッセージが表示されます。完了すると、ユーザーはコールバック URL に転送されます。
- コールバック ルートで認証コードを受け取ります。認可コードをアクセス トークンと更新トークンと交換します。
- トークンを使用して Google API を呼び出します。
OAuth 2.0 認証情報を取得する
概要ページの説明に従って、OAuth 認証情報を作成してダウンロードしていることを確認します。プロジェクトでは、これらの認証情報を使用してユーザーのログインを行う必要があります。
認可フローを実装する
ウェブアプリにロジックとルートを追加して、次のような機能を含め、説明したフローを実現します。
- ランディング ページに到達したら、承認フローを開始します。
- 認可をリクエストし、認可サーバーのレスポンスを処理します。
- 保存されている認証情報を消去します。
- アプリの権限を取り消す。
- API 呼び出しをテストします。
承認を開始する
必要に応じて、ランディング ページを変更して承認フローを開始します。アドオンの状態は 2 つあります。現在のセッションに保存されているトークンがある場合と、OAuth 2.0 サーバーからトークンを取得する必要がある場合です。セッションにトークンがある場合はテスト API 呼び出しを実行し、ない場合はユーザーにログインを求めます。
Python
routes.py ファイルを開きます。まず、iframe セキュリティの推奨事項に沿って、いくつかの定数と Cookie 構成を設定します。
# The file that contains the OAuth 2.0 client_id and client_secret.
CLIENT_SECRETS_FILE = "client_secret.json"
# The OAuth 2.0 access scopes to request.
# These scopes must match the scopes in your Google Cloud project's OAuth Consent
# Screen: https://console.cloud.google.com/apis/credentials/consent
SCOPES = [
"openid",
"https://www.googleapis.com/auth/userinfo.profile",
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/classroom.addons.teacher",
"https://www.googleapis.com/auth/classroom.addons.student"
]
# Flask cookie configurations.
app.config.update(
SESSION_COOKIE_SECURE=True,
SESSION_COOKIE_HTTPONLY=True,
SESSION_COOKIE_SAMESITE="None",
)
アドオンのランディング ルートに移動します（サンプルファイルでは /classroom-addon です）。セッションに「credentials」キーが含まれていない場合、ログインページをレンダリングするロジックを追加します。
@app.route("/classroom-addon")
def classroom_addon():
if "credentials" not in flask.session:
return flask.render_template("authorization.html")
return flask.render_template(
"addon-discovery.html",
message="You've reached the addon discovery page.")
Java
このチュートリアルのコードは step_02_sign_in モジュールにあります。
application.properties ファイルを開き、iframe セキュリティの推奨事項に沿ってセッション構成を追加します。
# iFrame security recommendations call for cookies to have the HttpOnly and
# secure attribute set
server.servlet.session.cookie.http-only=true
server.servlet.session.cookie.secure=true
# Ensures that the session is maintained across the iframe and sign-in pop-up.
server.servlet.session.cookie.same-site=none
コントローラ ファイルのエンドポイントのロジックを処理するサービスクラス（step_02_sign_in モジュールの AuthService.java）を作成し、アドオンに必要なリダイレクト URI、クライアント シークレット ファイルの場所、スコープを設定します。リダイレクト URI は、ユーザーがアプリを承認した後にユーザーを特定の URI にリダイレクトするために使用されます。client_secret.json ファイルを配置する場所については、ソースコードの README.md のプロジェクト設定セクションをご覧ください。
@Service
public class AuthService {
private static final String REDIRECT_URI = "https://localhost:5000/callback";
private static final String CLIENT_SECRET_FILE = "client_secret.json";
private static final HttpTransport HTTP_TRANSPORT = new NetHttpTransport();
private static final JsonFactory JSON_FACTORY = GsonFactory.getDefaultInstance();
private static final String[] REQUIRED_SCOPES = {
"https://www.googleapis.com/auth/userinfo.profile",
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/classroom.addons.teacher",
"https://www.googleapis.com/auth/classroom.addons.student"
};
/** Creates and returns a Collection object with all requested scopes.
* @return Collection of scopes requested by the application.
*/
public static Collection<String> getScopes() {
return new ArrayList<>(Arrays.asList(REQUIRED_SCOPES));
}
}
コントローラ ファイル（step_02_sign_in モジュールの AuthController.java）を開き、ランディング ルートにロジックを追加して、セッションに credentials キーが含まれていない場合にログイン ページをレンダリングします。
@GetMapping(value = {"/start-auth-flow"})
public String startAuthFlow(Model model) {
try {
return "authorization";
} catch (Exception e) {
return onError(e.getMessage(), model);
}
}
@GetMapping(value = {"/addon-discovery"})
public String addon_discovery(HttpSession session, Model model) {
try {
if (session == null || session.getAttribute("credentials") == null) {
return startAuthFlow(model);
}
return "addon-discovery";
} catch (Exception e) {
return onError(e.getMessage(), model);
}
}
認可ページには、ユーザーが「ログイン」するためのリンクまたはボタンが必要です。これをクリックすると、ユーザーは authorize ルートにリダイレクトされます。
承認をリクエストする
認可をリクエストするには、認証 URL を作成してユーザーをリダイレクトします。この URL には、リクエストされたスコープ、認証後の宛先ルート、ウェブアプリのクライアント ID など、いくつかの情報が含まれます。これらは、こちらの認可 URL のサンプルで確認できます。
Python
次のインポートを routes.py ファイルに追加します。
import google_auth_oauthlib.flow
新しいルート /authorize を作成します。google_auth_oauthlib.flow.Flow のインスタンスを作成します。付属の from_client_secrets_file メソッドを使用することを強くおすすめします。
@app.route("/authorize")
def authorize():
# Create flow instance to manage the OAuth 2.0 Authorization Grant Flow
# steps.
flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
CLIENT_SECRETS_FILE, scopes=SCOPES)
flow の redirect_uri を設定します。これは、アプリの承認後にユーザーを戻すルートです。次の例では /callback です。
# The URI created here must exactly match one of the authorized redirect
# URIs for the OAuth 2.0 client, which you configured in the API Console. If
# this value doesn't match an authorized URI, you will get a
# "redirect_uri_mismatch" error.
flow.redirect_uri = flask.url_for("callback", _external=True)
フロー オブジェクトを使用して、authorization_url と state を作成します。state をセッションに保存します。これは、後でサーバー レスポンスを検証するために使用されます。最後に、ユーザーを authorization_url にリダイレクトします。
authorization_url, state = flow.authorization_url(
# Enable offline access so that you can refresh an access token without
# re-prompting the user for permission. Recommended for web server apps.
access_type="offline",
# Enable incremental authorization. Recommended as a best practice.
include_granted_scopes="true")
# Store the state so the callback can verify the auth server response.
flask.session["state"] = state
# Redirect the user to the OAuth authorization URL.
return flask.redirect(authorization_url)
Java
AuthService.java ファイルに次のメソッドを追加してフロー オブジェクトをインスタンス化し、そのオブジェクトを使用して認可 URL を取得します。
getClientSecrets()メソッドは、クライアント シークレット ファイルを読み取り、GoogleClientSecretsオブジェクトを作成します。getFlow()メソッドはGoogleAuthorizationCodeFlowのインスタンスを作成します。authorize()メソッドは、GoogleAuthorizationCodeFlowオブジェクト、stateパラメータ、リダイレクト URI を使用して認可 URL を取得します。stateパラメータは、認可サーバーからのレスポンスの真正性を確認するために使用されます。メソッドは、認可 URL とstateパラメータを含むマップを返します。
/** Reads the client secret file downloaded from Google Cloud.
* @return GoogleClientSecrets read in from client secret file. */
public GoogleClientSecrets getClientSecrets() throws Exception {
try {
InputStream in = SignInApplication.class.getClassLoader()
.getResourceAsStream(CLIENT_SECRET_FILE);
if (in == null) {
throw new FileNotFoundException("Client secret file not found: "
+ CLIENT_SECRET_FILE);
}
GoogleClientSecrets clientSecrets = GoogleClientSecrets
.load(JSON_FACTORY, new InputStreamReader(in));
return clientSecrets;
} catch (Exception e) {
throw e;
}
}
/** Builds and returns authorization code flow.
* @return GoogleAuthorizationCodeFlow object used to retrieve an access
* token and refresh token for the application.
* @throws Exception if reading client secrets or building code flow object
* is unsuccessful.
*/
public GoogleAuthorizationCodeFlow getFlow() throws Exception {
try {
GoogleAuthorizationCodeFlow authorizationCodeFlow =
new GoogleAuthorizationCodeFlow.Builder(
HTTP_TRANSPORT,
JSON_FACTORY,
getClientSecrets(),
getScopes())
.setAccessType("offline")
.build();
return authorizationCodeFlow;
} catch (Exception e) {
throw e;
}
}
/** Builds and returns a map with the authorization URL, which allows the
* user to give the app permission to their account, and the state parameter,
* which is used to prevent cross site request forgery.
* @return map with authorization URL and state parameter.
* @throws Exception if building the authorization URL is unsuccessful.
*/
public HashMap authorize() throws Exception {
HashMap<String, String> authDataMap = new HashMap<>();
try {
String state = new BigInteger(130, new SecureRandom()).toString(32);
authDataMap.put("state", state);
GoogleAuthorizationCodeFlow flow = getFlow();
String authUrl = flow
.newAuthorizationUrl()
.setState(state)
.setRedirectUri(REDIRECT_URI)
.build();
String url = authUrl;
authDataMap.put("url", url);
return authDataMap;
} catch (Exception e) {
throw e;
}
}
コンストラクタ インジェクションを使用して、コントローラ クラスでサービスクラスのインスタンスを作成します。
/** Declare AuthService to be used in the Controller class constructor. */
private final AuthService authService;
/** AuthController constructor. Uses constructor injection to instantiate
* the AuthService and UserRepository classes.
* @param authService the service class that handles the implementation logic
* of requests.
*/
public AuthController(AuthService authService) {
this.authService = authService;
}
/authorize エンドポイントをコントローラ クラスに追加します。このエンドポイントは、AuthService の authorize() メソッドを呼び出して、state パラメータと認可 URL を取得します。その後、エンドポイントは state パラメータをセッションに保存し、ユーザーを認可 URL にリダイレクトします。
/** Redirects the sign-in pop-up to the authorization URL.
* @param response the current response to pass information to.
* @param session the current session.
* @throws Exception if redirection to the authorization URL is unsuccessful.
*/
@GetMapping(value = {"/authorize"})
public void authorize(HttpServletResponse response, HttpSession session)
throws Exception {
try {
HashMap authDataMap = authService.authorize();
String authUrl = authDataMap.get("url").toString();
String state = authDataMap.get("state").toString();
session.setAttribute("state", state);
response.sendRedirect(authUrl);
} catch (Exception e) {
throw e;
}
}
サーバー レスポンスを処理する
承認すると、ユーザーは前のステップの redirect_uri ルートに戻ります。上の例では、このルートは /callback です。
ユーザーが認可ページから戻ると、レスポンスで code が返されます。次に、コードをアクセス トークンと更新トークンと交換します。
Python
Flask サーバー ファイルに次のインポートを追加します。
import google.oauth2.credentials
import googleapiclient.discovery
サーバーにルートを追加します。google_auth_oauthlib.flow.Flow の別のインスタンスを作成します。ただし、今回は前の手順で保存した状態を再利用します。
@app.route("/callback")
def callback():
state = flask.session["state"]
flow = google_auth_oauthlib.flow.Flow.from_client_secrets_file(
CLIENT_SECRETS_FILE, scopes=SCOPES, state=state)
flow.redirect_uri = flask.url_for("callback", _external=True)
次に、アクセス トークンと更新トークンをリクエストします。幸い、flow オブジェクトには、この目的を達成するための fetch_token メソッドも含まれています。このメソッドには、code または authorization_response の引数が必要です。authorization_response はリクエストの完全な URL であるため、これを使用します。
authorization_response = flask.request.url
flow.fetch_token(authorization_response=authorization_response)
これで認証情報がすべて揃いました。他のメソッドやルートで取得できるようにセッションに保存し、アドオンのランディング ページにリダイレクトします。
credentials = flow.credentials
flask.session["credentials"] = {
"token": credentials.token,
"refresh_token": credentials.refresh_token,
"token_uri": credentials.token_uri,
"client_id": credentials.client_id,
"client_secret": credentials.client_secret,
"scopes": credentials.scopes
}
# Close the pop-up by rendering an HTML page with a script that redirects
# the owner and closes itself. This can be done with a bit of JavaScript:
# <script>
# window.opener.location.href = "{{ url_for('classroom_addon') }}";
# window.close();
# </script>
return flask.render_template("close-me.html")
Java
承認 URL によって実行されたリダイレクトから取得した認証コードを渡して Credentials オブジェクトを返すメソッドをサービスクラスに追加します。この Credentials オブジェクトは、後でアクセス トークンと更新トークンを取得するために使用されます。
/** Returns the required credentials to access Google APIs.
* @param authorizationCode the authorization code provided by the
* authorization URL that's used to obtain credentials.
* @return the credentials that were retrieved from the authorization flow.
* @throws Exception if retrieving credentials is unsuccessful.
*/
public Credential getAndSaveCredentials(String authorizationCode) throws Exception {
try {
GoogleAuthorizationCodeFlow flow = getFlow();
GoogleClientSecrets googleClientSecrets = getClientSecrets();
TokenResponse tokenResponse = flow.newTokenRequest(authorizationCode)
.setClientAuthentication(new ClientParametersAuthentication(
googleClientSecrets.getWeb().getClientId(),
googleClientSecrets.getWeb().getClientSecret()))
.setRedirectUri(REDIRECT_URI)
.execute();
Credential credential = flow.createAndStoreCredential(tokenResponse, null);
return credential;
} catch (Exception e) {
throw e;
}
}
リダイレクト URI のエンドポイントをコントローラに追加します。リクエストから認証コードと state パラメータを取得します。この state パラメータを、セッションに保存されている state 属性と比較します。一致する場合は、承認フローを続行します。一致しない場合は、エラーを返します。
次に、AuthService getAndSaveCredentials メソッドを呼び出し、認証コードをパラメータとして渡します。Credentials オブジェクトを取得したら、セッションに保存します。次に、ダイアログを閉じて、ユーザーをアドオンのランディング ページにリダイレクトします。
/** Handles the redirect URL to grant the application access to the user's
* account.
* @param request the current request used to obtain the authorization code
* and state parameter from.
* @param session the current session.
* @param response the current response to pass information to.
* @param model the Model interface to pass error information that's
* displayed on the error page.
* @return the close-pop-up template if authorization is successful, or the
* onError method to handle and display the error message.
*/
@GetMapping(value = {"/callback"})
public String callback(HttpServletRequest request, HttpSession session,
HttpServletResponse response, Model model) {
try {
String authCode = request.getParameter("code");
String requestState = request.getParameter("state");
String sessionState = session.getAttribute("state").toString();
if (!requestState.equals(sessionState)) {
response.setStatus(401);
return onError("Invalid state parameter.", model);
}
Credential credentials = authService.getAndSaveCredentials(authCode);
session.setAttribute("credentials", credentials);
return "close-pop-up";
} catch (Exception e) {
return onError(e.getMessage(), model);
}
}
API 呼び出しをテストする
フローが完了したので、Google API を呼び出すことができます。
たとえば、ユーザーのプロフィール情報をリクエストします。ユーザーの情報をリクエストするには、OAuth 2.0 API を使用します。
Python
OAuth 2.0 Discovery API のドキュメントを読み、その API を使用して、入力済みの UserInfo オブジェクトを取得します。
# Retrieve the credentials from the session data and construct a
# Credentials instance.
credentials = google.oauth2.credentials.Credentials(
**flask.session["credentials"])
# Construct the OAuth 2.0 v2 discovery API library.
user_info_service = googleapiclient.discovery.build(
serviceName="oauth2", version="v2", credentials=credentials)
# Request and store the username in the session.
# This allows it to be used in other methods or in an HTML template.
flask.session["username"] = (
user_info_service.userinfo().get().execute().get("name"))
Java
サービスクラスに、Credentials をパラメータとして UserInfo オブジェクトを作成するメソッドを作成します。
/** Obtains the Userinfo object by passing in the required credentials.
* @param credentials retrieved from the authorization flow.
* @return the Userinfo object for the currently signed-in user.
* @throws IOException if creating UserInfo service or obtaining the
* Userinfo object is unsuccessful.
*/
public Userinfo getUserInfo(Credential credentials) throws IOException {
try {
Oauth2 userInfoService = new Oauth2.Builder(
new NetHttpTransport(),
new GsonFactory(),
credentials).build();
Userinfo userinfo = userInfoService.userinfo().get().execute();
return userinfo;
} catch (Exception e) {
throw e;
}
}
ユーザーのメールアドレスを表示するコントローラに /test エンドポイントを追加します。
/** Returns the test request page with the user's email.
* @param session the current session.
* @param model the Model interface to pass error information that's
* displayed on the error page.
* @return the test page that displays the current user's email or the
* onError method to handle and display the error message.
*/
@GetMapping(value = {"/test"})
public String test(HttpSession session, Model model) {
try {
Credential credentials = (Credential) session.getAttribute("credentials");
Userinfo userInfo = authService.getUserInfo(credentials);
String userInfoEmail = userInfo.getEmail();
if (userInfoEmail != null) {
model.addAttribute("userEmail", userInfoEmail);
} else {
return onError("Could not get user email.", model);
}
return "test";
} catch (Exception e) {
return onError(e.getMessage(), model);
}
}
認証ストレージの消去
ユーザーの認証情報を「消去」するには、現在のセッションから削除します。これにより、アドオンのランディング ページでルーティングをテストできます。
アドオンのランディング ページにリダイレクトする前に、ユーザーがログアウトしたことを示すことをおすすめします。アプリは承認フローを経て新しい認証情報を取得する必要がありますが、ユーザーにアプリの再承認を求めるメッセージは表示されません。
Python
@app.route("/clear")
def clear_credentials():
if "credentials" in flask.session:
del flask.session["credentials"]
del flask.session["username"]
return flask.render_template("signed-out.html")
または flask.session.clear() を使用することもできますが、セッションに他の値が保存されている場合は、意図しない影響が生じる可能性があります。
Java
コントローラに /clear エンドポイントを追加します。
/** Clears the credentials in the session and returns the sign-out
* confirmation page.
* @param session the current session.
* @return the sign-out confirmation page.
*/
@GetMapping(value = {"/clear"})
public String clear(HttpSession session) {
try {
if (session != null && session.getAttribute("credentials") != null) {
session.removeAttribute("credentials");
}
return "sign-out";
} catch (Exception e) {
return onError(e.getMessage(), model);
}
}
アプリの権限を取り消す
ユーザーは、https://oauth2.googleapis.com/revoke に POST リクエストを送信することで、アプリの権限を取り消すことができます。リクエストにはユーザーのアクセス トークンが含まれている必要があります。
Python
import requests
@app.route("/revoke")
def revoke():
if "credentials" not in flask.session:
return flask.render_template("addon-discovery.html",
message="You need to authorize before " +
"attempting to revoke credentials.")
credentials = google.oauth2.credentials.Credentials(
**flask.session["credentials"])
revoke = requests.post(
"https://oauth2.googleapis.com/revoke",
params={"token": credentials.token},
headers={"content-type": "application/x-www-form-urlencoded"})
if "credentials" in flask.session:
del flask.session["credentials"]
del flask.session["username"]
status_code = getattr(revoke, "status_code")
if status_code == 200:
return flask.render_template("authorization.html")
else:
return flask.render_template(
"index.html", message="An error occurred during revocation!")
Java
取り消しエンドポイントを呼び出すメソッドをサービスクラスに追加します。
/** Revokes the app's permissions to the user's account.
* @param credentials retrieved from the authorization flow.
* @return response entity returned from the HTTP call to obtain response
* information.
* @throws RestClientException if the POST request to the revoke endpoint is
* unsuccessful.
*/
public ResponseEntity<String> revokeCredentials(Credential credentials) throws RestClientException {
try {
String accessToken = credentials.getAccessToken();
String url = "https://oauth2.googleapis.com/revoke?token=" + accessToken;
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.setContentType(MediaType.APPLICATION_FORM_URLENCODED_VALUE);
HttpEntity<Object> httpEntity = new HttpEntity<Object>(httpHeaders);
ResponseEntity<String> responseEntity = new RestTemplate().exchange(
url,
HttpMethod.POST,
httpEntity,
String.class);
return responseEntity;
} catch (RestClientException e) {
throw e;
}
}
セッションを消去し、取り消しが成功した場合はユーザーを認可ページにリダイレクトするエンドポイント /revoke をコントローラに追加します。
/** Revokes the app's permissions and returns the authorization page.
* @param session the current session.
* @return the authorization page.
* @throws Exception if revoking access is unsuccessful.
*/
@GetMapping(value = {"/revoke"})
public String revoke(HttpSession session) throws Exception {
try {
if (session != null && session.getAttribute("credentials") != null) {
Credential credentials = (Credential) session.getAttribute("credentials");
ResponseEntity responseEntity = authService.revokeCredentials(credentials);
Integer httpStatusCode = responseEntity.getStatusCodeValue();
if (httpStatusCode != 200) {
return onError("There was an issue revoking access: " +
responseEntity.getStatusCode(), model);
}
session.removeAttribute("credentials");
}
return startAuthFlow(model);
} catch (Exception e) {
return onError(e.getMessage(), model);
}
}
アドオンをテストする
教師のテストユーザーとして Google Classroom にログインします。[授業] タブに移動し、新しい [課題] を作成します。テキスト エリアの下にある [アドオン] ボタンをクリックし、アドオンを選択します。iframe が開き、GWM SDK の [アプリの設定] ページで指定したアタッチメント設定 URI がアドオンによって読み込まれます。
これで、これで、次のステップであるアドオンへの繰り返しアクセスの処理に進むことができます。