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

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 है फ़ाइल से लिया जाता है). अगर सेशन में साइन-इन पेज में यह शामिल नहीं है, तो साइन-इन पेज को रेंडर करने के लिए लॉजिक जोड़ें "क्रेडेंशियल" बटन दबाएं.

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

@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

अपनी फ़्लास्क सर्वर फ़ाइल में ये इंपोर्ट जोड़ें.

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

सर्विस क्लास में कोई ऐसा तरीका बनाएं जो इसका इस्तेमाल करके UserInfo ऑब्जेक्ट बनाता हो Credentials को पैरामीटर के तौर पर चुनें.

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