Firebase क्लाउड फंक्शन HTTP एंडपॉइंट की सुरक्षा के लिए केवल Firebase प्रमाणित उपयोगकर्ताओं की अनुमति कैसे दें?


141

नए फायरबेस क्लाउड फ़ंक्शन के साथ मैंने अपने कुछ HTTP एंडपॉइंट को फायरबेस में ले जाने का फैसला किया है। सब कुछ बहुत अच्छा काम करता है ... लेकिन मेरे पास निम्नलिखित समस्या है। मेरे पास HTTP ट्रिगर (क्लाउड फ़ंक्शंस) द्वारा बनाए गए दो अंतिम बिंदु हैं

  1. एक एपीआई उपयोगकर्ताओं को बनाने के लिए समापन बिंदु और फायरबेस व्यवस्थापक एसडीके द्वारा उत्पन्न कस्टम टोकन लौटाता है।
  2. एक एपीआई समापन बिंदु कुछ उपयोगकर्ता विवरण लाने के लिए।

हालांकि पहला समापन बिंदु ठीक है, लेकिन मेरे दूसरे अंत बिंदु के लिए मैं इसे केवल प्रमाणित उपयोगकर्ताओं के लिए सुरक्षित रखना चाहता हूं। जिसका अर्थ है कि जिसके पास टोकन है, मैंने पहले उत्पन्न किया था।

मैं इसे कैसे हल करूं?

मुझे पता है कि हम क्लाउड फ़ंक्शन का उपयोग करके हैडर पैरामीटर प्राप्त कर सकते हैं

request.get('x-myheader')

लेकिन क्या वास्तविक समय डेटा बेस की रक्षा करने की तरह ही समापन बिंदु की रक्षा करने का एक तरीका है?


पहली API में आपको Firebase Admin SDK द्वारा उत्पन्न कस्टम टोकन कैसे मिला
Amine Harbaoui

2
@AmineHarbaoui मेरा वही सवाल था। इस पृष्ठ को देखें: firebase.google.com/docs/auth/admin/verify-id-tokens
MichM

जवाबों:


137

आप क्या करने का प्रयास कर रहे हैं, इसके लिए एक आधिकारिक कोड नमूना है। यह दिखाता है कि प्रमाणीकरण के दौरान क्लाइंट को प्राप्त टोकन के साथ प्राधिकरण हेडर की आवश्यकता के लिए अपने HTTPS फ़ंक्शन को कैसे सेट करना है। टोकन को सत्यापित करने के लिए फ़ंक्शन फायरबेस-व्यवस्थापक लाइब्रेरी का उपयोग करता है।

साथ ही, आप इस बॉयलरप्लेट को बहुत आसान बनाने के लिए "कॉल करने योग्य कार्यों " का उपयोग कर सकते हैं , यदि आपका ऐप फायरबेस क्लाइंट लाइब्रेरीज़ का उपयोग करने में सक्षम है।


2
क्या यह कोड नमूना अभी भी मान्य है? क्या आज भी आप इसे संबोधित करेंगे?
गल ब्राच

1
@GalBracha यह आज भी मान्य होना चाहिए (31 अक्टूबर 2017)।
डग स्टीवेंसन

@DougStevenson उन 'कंसोल.लॉग' कॉल का प्रदर्शन पर कोई 'ध्यान देने योग्य' प्रभाव पड़ेगा?
शंका दर्शन 4

1
कॉल करने योग्य कार्यों का उपयोग करके बॉयलरप्लेट को कैसे आसान बनाया जाएगा? जो मैं समझता हूं कि वे केवल "गैर-आरईएसटी" सर्वर फ़ंक्शन हैं, मैं वास्तव में नहीं समझता कि वे यहां कैसे संबंधित हैं। धन्यवाद।
1252748

2
@ 1252748 यदि आप लिंक किए गए दस्तावेज़ को पढ़ते हैं, तो यह स्पष्ट हो जाएगा। यह स्वतः ही टोकन के पारित होने और सत्यापन को संभालता है, इसलिए आपको उस कोड को दोनों तरफ लिखना नहीं है।
डग स्टीवेन्सन

121

जैसा कि @Doug द्वारा बताया गया है, आप firebase-adminएक टोकन को सत्यापित करने के लिए उपयोग कर सकते हैं । मैंने एक त्वरित उदाहरण स्थापित किया है:

exports.auth = functions.https.onRequest((req, res) => {
  cors(req, res, () => {
    const tokenId = req.get('Authorization').split('Bearer ')[1];

    return admin.auth().verifyIdToken(tokenId)
      .then((decoded) => res.status(200).send(decoded))
      .catch((err) => res.status(401).send(err));
  });
});

ऊपर के उदाहरण में, मैंने भी CORS को सक्षम किया है, लेकिन यह वैकल्पिक है। सबसे पहले, आप Authorizationहेडर प्राप्त करते हैं और पता लगाते हैं token

फिर, आप firebase-adminउस टोकन को सत्यापित करने के लिए उपयोग कर सकते हैं । आपको प्रतिक्रिया में उस उपयोगकर्ता के लिए डिकोड की गई जानकारी मिल जाएगी। अन्यथा, यदि टोकन मान्य नहीं है, तो यह एक त्रुटि फेंक देगा।


13
यह सरल है, और आधिकारिक उदाहरण की तरह व्यक्त पर निर्भर नहीं करता है।
डार्कनार्टन

5
क्या आप कॉर्स के बारे में अधिक बता सकते हैं?
पीट

@pete: cors सिर्फ क्रॉस-ऑरिजनल रिसोर्स शेयरिंग को हल कर रहा है। इसके बारे में अधिक जानने के लिए आप google कर सकते हैं।
बजे Hoàng

@pete कोर्स आपको अलग-अलग यूआरएल से उस फायरबेस-बैकएंड एंड-पॉइंट को हिट करने की अनुमति देता है।
वाल्टर मोनेके

6
@RezaRahmati आप उपयोग कर सकते हैं getIdToken()क्लाइंट साइड (जैसे पर विधि firebase.auth().currentUser.getIdToken().then(token => console.log(token))) डॉक्स firebase
विल

18

जैसा कि @Doug द्वारा भी उल्लेख किया गया है, आप अपने क्लाइंट और अपने सर्वर से कुछ बॉयलरप्लेट कोड को बाहर करने के लिए Callable Functions का उपयोग कर सकते हैं ।

Exampale callable function:

export const getData = functions.https.onCall((data, context) => {
  // verify Firebase Auth ID token
  if (!context.auth) {
    return { message: 'Authentication Required!', code: 401 };
  }

  // do your things..
  const uid = context.auth.uid;
  const query = data.query;

  return { message: 'Some Data', code: 400 };
});

यह आप से सीधे आह्वान किया जा सकता है जैसे ग्राहक:

firebase.functions().httpsCallable('getData')({query}).then(result => console.log(result));

2

उपरोक्त विधियाँ फ़ंक्शन के अंदर तर्क का उपयोग करके उपयोगकर्ता को प्रमाणित करती हैं , इसलिए चेकिंग करने के लिए फ़ंक्शन को अभी भी लागू किया जाना चाहिए।

यह पूरी तरह से ठीक तरीका है, लेकिन व्यापकता के लिए, एक विकल्प है:

आप "निजी" होने के लिए एक फ़ंक्शन सेट कर सकते हैं ताकि इसे पंजीकृत उपयोगकर्ताओं (आप अनुमतियों पर निर्णय लें) को छोड़कर नहीं किया जा सके। इस मामले में, फ़ंक्शन के संदर्भ के बाहर अप्रमाणित अनुरोध अस्वीकार कर दिए जाते हैं, और फ़ंक्शन को बिल्कुल भी लागू नहीं किया जाता है।

यहां (ए) सार्वजनिक / निजी के रूप में कॉन्फ़िगर करने वाले फ़ंक्शन , और फिर (बी) आपके कार्यों के लिए अंतिम-उपयोगकर्ताओं को प्रमाणित कर रहे हैं

ध्यान दें कि ऊपर दिए गए डॉक्स Google क्लाउड प्लेटफ़ॉर्म के लिए हैं, और वास्तव में, यह काम करता है क्योंकि हर फायरबेस प्रोजेक्ट एक GCP प्रोजेक्ट भी है। इस पद्धति के साथ एक संबंधित चेतावनी यह है कि लेखन के रूप में, यह केवल Google-खाता आधारित प्रमाणीकरण के साथ काम करता है।


1

एक्सप्रेस का उपयोग करते हुए इस पर एक अच्छा आधिकारिक उदाहरण है - भविष्य में उपयोगी हो सकता है: https://github.com/firebase/functions-samples/blob/master/authorized-https-endpoint/functions/index.js (बस नीचे चिपकाए गए) पक्का)

ध्यान रखें कि स्लग के exports.appतहत आपके कार्य उपलब्ध हैं /app(इस मामले में केवल एक फ़ंक्शन है और इसके तहत उपलब्ध है <you-firebase-app>/app/hello। इससे छुटकारा पाने के लिए आपको वास्तव में एक्सप्रेस भाग को थोड़ा फिर से लिखना होगा (सत्यापन के लिए मिडलवेयर हिस्सा वही रहता है - यह बहुत काम करता है) अच्छा है और टिप्पणियों के लिए काफी समझ में आता है)।

/**
 * Copyright 2016 Google Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
'use strict';

const functions = require('firebase-functions');
const admin = require('firebase-admin');
admin.initializeApp();
const express = require('express');
const cookieParser = require('cookie-parser')();
const cors = require('cors')({origin: true});
const app = express();

// Express middleware that validates Firebase ID Tokens passed in the Authorization HTTP header.
// The Firebase ID token needs to be passed as a Bearer token in the Authorization HTTP header like this:
// `Authorization: Bearer <Firebase ID Token>`.
// when decoded successfully, the ID Token content will be added as `req.user`.
const validateFirebaseIdToken = async (req, res, next) => {
  console.log('Check if request is authorized with Firebase ID token');

  if ((!req.headers.authorization || !req.headers.authorization.startsWith('Bearer ')) &&
      !(req.cookies && req.cookies.__session)) {
    console.error('No Firebase ID token was passed as a Bearer token in the Authorization header.',
        'Make sure you authorize your request by providing the following HTTP header:',
        'Authorization: Bearer <Firebase ID Token>',
        'or by passing a "__session" cookie.');
    res.status(403).send('Unauthorized');
    return;
  }

  let idToken;
  if (req.headers.authorization && req.headers.authorization.startsWith('Bearer ')) {
    console.log('Found "Authorization" header');
    // Read the ID Token from the Authorization header.
    idToken = req.headers.authorization.split('Bearer ')[1];
  } else if(req.cookies) {
    console.log('Found "__session" cookie');
    // Read the ID Token from cookie.
    idToken = req.cookies.__session;
  } else {
    // No cookie
    res.status(403).send('Unauthorized');
    return;
  }

  try {
    const decodedIdToken = await admin.auth().verifyIdToken(idToken);
    console.log('ID Token correctly decoded', decodedIdToken);
    req.user = decodedIdToken;
    next();
    return;
  } catch (error) {
    console.error('Error while verifying Firebase ID token:', error);
    res.status(403).send('Unauthorized');
    return;
  }
};

app.use(cors);
app.use(cookieParser);
app.use(validateFirebaseIdToken);
app.get('/hello', (req, res) => {
  res.send(`Hello ${req.user.name}`);
});

// This HTTPS endpoint can only be accessed by your Firebase Users.
// Requests need to be authorized by providing an `Authorization` HTTP header
// with value `Bearer <Firebase ID Token>`.
exports.app = functions.https.onRequest(app);

मेरे छुटकारा पाने के लिए फिर से लिखना /app:

const hello = functions.https.onRequest((request, response) => {
  res.send(`Hello ${req.user.name}`);
})

module.exports = {
  hello
}

0

मैं golang GCP फ़ंक्शन में उचित फायरबेस प्रमाणीकरण प्राप्त करने के लिए संघर्ष कर रहा हूं। उसके लिए वास्तव में कोई उदाहरण नहीं है, इसलिए मैंने इस छोटे पुस्तकालय को बनाने का फैसला किया: https://github.com/Jblew/go-firebase-auth-in-gcp-functions

अब आप आसानी से उपयोगकर्ताओं को फायरबेस-कोर (जो जीसीपी-प्रामाणिक-कार्यों से अलग है और पहचान-जागरूक-प्रॉक्सी द्वारा सीधे समर्थित नहीं हैं) का उपयोग करके प्रमाणित कर सकते हैं।

यहाँ उपयोगिता का उपयोग करने का एक उदाहरण है:

import (
  firebaseGcpAuth "github.com/Jblew/go-firebase-auth-in-gcp-functions"
  auth "firebase.google.com/go/auth"
)

func SomeGCPHttpCloudFunction(w http.ResponseWriter, req *http.Request) error {
   // You need to provide 1. Context, 2. request, 3. firebase auth client
  var client *auth.Client
    firebaseUser, err := firebaseGcpAuth.AuthenticateFirebaseUser(context.Background(), req, authClient)
    if err != nil {
    return err // Error if not authenticated or bearer token invalid
  }

  // Returned value: *auth.UserRecord
}

बस आपको --allow-unauthenticatedफ़्लैग के साथ फ़ंक्शन को तैनात करने के लिए ध्यान रखें (क्योंकि फ़ंक्शन निष्पादन के अंदर फायरबेस प्रमाणीकरण होता है)।

आशा है कि यह आपकी मदद करेगा क्योंकि इसने मेरी मदद की। मैं प्रदर्शन के कारणों के लिए क्लाउड कार्यों के लिए गोलंग का उपयोग करने के लिए दृढ़ था - जोदरेज


0

फायरबेस में, आपके कोड और आपके काम को आसान बनाने के लिए, यह सिर्फ वास्तुशिल्प डिजाइन की बात है :

  1. सार्वजनिक सुलभ साइटों / सामग्री के लिए , HTTPS ट्रिगर्स काExpress उपयोग करें । केवल साइटसाइट या विशिष्ट साइट को प्रतिबंधित करने के लिए , CORSसुरक्षा के इस पहलू को नियंत्रित करने के लिए उपयोग करें। यह समझ में आता है क्योंकि Expressअपने सर्वर-साइड रेंडरिंग सामग्री के कारण SEO के लिए उपयोगी है।
  2. उन ऐप्स के लिए जिन्हें उपयोगकर्ता प्रमाणीकरण की आवश्यकता होती है , HTTPS Callable Firebase फ़ंक्शंस का उपयोग करें, फिर contextसभी बाधाओं को बचाने के लिए पैरामीटर का उपयोग करें । यह भी समझ में आता है, क्योंकि जैसे कि AngularJS - AngularJS के साथ बनाया गया एक सिंगल पेज ऐप SEO के लिए बुरा है, लेकिन चूंकि यह एक पासवर्ड प्रोटेक्टेड ऐप है, इसलिए आपको SEO की ज़्यादा ज़रूरत नहीं है। टेंपलेटिंग के लिए, एंगुलरजेएस में अंतर्निहित टेम्प्लेटिंग है, इसलिए इसके साथ गंभीर साइड टेम्पलेट की कोई आवश्यकता नहीं है Express। फिर Firebase Callable Functions काफी अच्छे होने चाहिए।

मन में ऊपर के साथ, कोई और अधिक परेशानी और जीवन को आसान नहीं बनाता है।

हमारी साइट का प्रयोग करके, आप स्वीकार करते हैं कि आपने हमारी Cookie Policy और निजता नीति को पढ़ और समझा लिया है।
Licensed under cc by-sa 3.0 with attribution required.