उपयोगकर्ता को साइन इन करने दें

Python

अपनी routes.py फ़ाइल खोलें. सबसे पहले, iframe की सुरक्षा से जुड़े सुझावों के मुताबिक, कुछ कॉन्स्टेंट और हमारी कुकी कॉन्फ़िगरेशन सेट करें.

# 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) बनाएं. साथ ही, रीडायरेक्ट यूआरआई, क्लाइंट के गोपनीय पासवर्ड की फ़ाइल की जगह, और उन स्कोप को सेट अप करें जिनकी आपके ऐड-ऑन को ज़रूरत है. रीडायरेक्ट यूआरआई का इस्तेमाल, आपके ऐप्लिकेशन को अनुमति देने के बाद, उपयोगकर्ताओं को किसी खास यूआरआई पर रीडायरेक्ट करने के लिए किया जाता है. 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);
    }
}

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 फ़ाइल में ये तरीके जोड़ें. इसके बाद, अनुमति वाले यूआरएल को वापस पाने के लिए इसका इस्तेमाल करें:

• getClientSecrets() तरीका, क्लाइंट सेक्रेट फ़ाइल को पढ़ता है और GoogleClientSecrets ऑब्जेक्ट बनाता है.
• getFlow() तरीका, GoogleAuthorizationCodeFlow का एक इंस्टेंस बनाता है.
• अनुमति देने वाले यूआरएल को वापस पाने के लिए, authorize() तरीका GoogleAuthorizationCodeFlow ऑब्जेक्ट, state पैरामीटर, और रीडायरेक्ट यूआरआई का इस्तेमाल करता है. state पैरामीटर का इस्तेमाल, अनुमति देने वाले सर्वर से मिले रिस्पॉन्स की पुष्टि करने के लिए किया जाता है. इसके बाद, यह तरीका अनुमति वाले यूआरएल और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 एंडपॉइंट जोड़ें. यह एंडपॉइंट, state पैरामीटर और ऑथराइज़ेशन यूआरएल को वापस पाने के लिए, AuthService authorize() तरीके को कॉल करता है. इसके बाद, एंडपॉइंट state पैरामीटर को सेशन में सेव करता है और उपयोगकर्ताओं को अनुमति देने वाले यूआरएल पर रीडायरेक्ट करता है.

/** 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;
    }
}

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 का इस्तेमाल करें, क्योंकि यह अनुरोध का पूरा यूआरएल है.

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

अपनी सेवा क्लास में एक ऐसा तरीका जोड़ें जो ऑथराइज़ेशन यूआरएल से किए गए रीडायरेक्ट से मिले ऑथराइज़ेशन कोड को पास करके, 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;
    }
}

कंट्रोलर में अपने रीडायरेक्ट यूआरआई के लिए एंडपॉइंट जोड़ें. अनुरोध से अनुमति कोड और 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);
    }
}

Python

OAuth 2.0 डिस्कवरी एपीआई के लिए दस्तावेज़ पढ़ें और जानकारी से भरा 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);
    }
}

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);
    }
}