如何保护Firebase Cloud Function HTTP端点,使其只允许Firebase认证用户?

zfycwa2u  于 2023-06-24  发布在  其他
关注(0)|答案(9)|浏览(134)

有了新的firebase云功能,我决定将我的一些HTTP端点移动到firebase。一切都很好...但我有以下问题。我有两个由HTTP触发器构建的端点(云函数)

  1. API端点,用于创建用户并返回Firebase Admin SDK生成的自定义令牌。
    1.用于获取某些用户详细信息的API端点。
    虽然第一个端点是好的,但对于我的第二个端点,我希望只为经过身份验证的用户保护它。也就是说拥有我之前生成的令牌的人。
    我该如何着手解决这个问题?
    我知道我们可以在云函数中使用Header参数
request.get('x-myheader')

但是有没有一种方法可以像保护真实的数据库一样保护端点呢?

nhn9ugyo

nhn9ugyo1#

有一个官方的code sample来说明你要做的事情。它演示了如何设置HTTPS函数,以要求使用客户端在身份验证期间接收到的令牌的Authorization头。该函数使用firebase-admin库来验证令牌。
此外,如果您的应用能够使用Firebase客户端库,您可以使用“callable functions”来使许多模板更容易。

rsl1atfo

rsl1atfo2#

正如@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来验证该令牌。您将在响应中获得该用户的解码信息。否则,如果令牌无效,它将抛出一个错误。

zaqlnxep

zaqlnxep3#

正如@Doug所提到的,您可以使用Callable Functions来从您的客户端和服务器获取exclude some boilerplate code
示例可调用函数:

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

  /** This scope is reachable for authenticated users only */

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

它可以直接从客户端调用,如下所示:

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

3yhwsihp4#

上面的方法使用函数内部的逻辑对用户进行身份验证,因此必须仍然调用函数来进行检查。
这是一个很好的方法,但为了全面起见,还有一个替代方案:
你可以将一个函数设置为“私有”,这样除了注册用户之外,它就不能被调用(权限由你决定)。在这种情况下,未经验证的请求在函数的上下文之外被拒绝,并且函数根本不会被调用。
下面是对(a)将函数配置为public/private,然后(b)authenticating end-users to your functions的引用。
请注意,上面的文档是针对Google Cloud Platform的,实际上,这是可行的,因为每个Firebase项目也是GCP项目。与此方法相关的一个警告是,截至撰写本文时,它仅适用于基于Google帐户的身份验证。

67up9zun

67up9zun5#

在Firebase中,为了简化您的代码和工作,只需架构设计
1.对于公共访问站点/内容,请使用HTTPS triggers with Express。要仅限制同一站点或仅特定站点,请使用CORS来控制这方面的安全性。这是有意义的,因为Express由于其服务器端渲染内容而对SEO非常有用。
1.对于需要用户认证的应用,使用HTTPS Callable Firebase Functions,然后使用context参数来保存所有麻烦。这也是有道理的,因为例如用AngularJS构建的单页应用程序- AngularJS对SEO不利,但由于它是一个受密码保护的应用程序,因此您也不需要太多的SEO。至于模板,AngularJS有内置的模板,所以不需要Express的服务器端模板。那么Firebase Callable Functions就足够了。
考虑到上述情况,没有更多的麻烦,使生活更容易。

btxsgosb

btxsgosb6#

你可以把它当作函数返回布尔值。如果用户验证与否,您将继续或停止您的API。此外,您可以从变量decode返回声明或用户结果

const authenticateIdToken = async (
    req: functions.https.Request,
    res: functions.Response<any>
) => {
    try {
        const authorization = req.get('Authorization');
        if (!authorization) {
            res.status(400).send('Not Authorized User');
            return false;
        }
        const tokenId = authorization.split('Bearer ')[1];

        return await auth().verifyIdToken(tokenId)
            .then((decoded) => {
                return true;
            })
            .catch((err) => {
                res.status(401).send('Not Authorized User')
                return false;
            });
    } catch (e) {
        res.status(400).send('Not Authorized User')
        return false;
    }
}
tyky79it

tyky79it7#

这里有很多很棒的信息,对我很有帮助,但我认为为第一次使用Angular尝试的人分解一个简单的工作示例可能会很好。Google Firebase文档可在www.example.com找到https://firebase.google.com/docs/auth/admin/verify-id-tokens#web。

//#### YOUR TS COMPONENT FILE #####
import { Component, OnInit} from '@angular/core';
import * as firebase from 'firebase/app';
import { YourService } from '../services/yourservice.service';

@Component({
  selector: 'app-example',
  templateUrl: './app-example.html',
  styleUrls: ['./app-example.scss']
})

export class AuthTokenExample implements OnInit {

//property
idToken: string;

//Add your service
constructor(private service: YourService) {}

ngOnInit() {

    //get the user token from firebase auth
    firebase.auth().currentUser.getIdToken(true).then((idTokenData) => {
        //assign the token to the property
        this.idToken = idTokenData;
        //call your http service upon ASYNC return of the token
        this.service.myHttpPost(data, this.idToken).subscribe(returningdata => {
            console.log(returningdata)
        });

    }).catch((error) => {
        // Handle error
        console.log(error);
    });

  }

}

//#### YOUR SERVICE #####
//import of http service
import { Injectable } from '@angular/core';
import { HttpClient, HttpHeaders } from '@angular/common/http';
import { Observable } from 'rxjs';

@Injectable({
  providedIn: 'root'
})

export class MyServiceClass {

    constructor(private http: HttpClient) { }

  //your myHttpPost method your calling from your ts file
  myHttpPost(data: object, token: string): Observable<any> {

    //defining your header - token is added to Authorization Bearer key with space between Bearer, so it can be split in your Google Cloud Function
    let httpOptions = {
        headers: new HttpHeaders({
            'Content-Type': 'application/json',
         'Authorization': 'Bearer ' + token
        })
    }

    //define your Google Cloud Function end point your get from creating your GCF
    const endPoint = ' https://us-central1-your-app.cloudfunctions.net/doSomethingCool';

    return this.http.post<string>(endPoint, data, httpOptions);

  }

}

//#### YOUR GOOGLE CLOUD FUNCTION 'GCF' #####
//your imports
const functions = require('firebase-functions');
const admin = require('firebase-admin');
const cors = require('cors')({origin: true});

exports.doSomethingCool = functions.https.onRequest((req, res) => {

//cross origin middleware
    cors(req, res, () => {

        //get the token from the service header by splitting the Bearer in the Authorization header 
        const tokenId = req.get('Authorization').split('Bearer ')[1];

        //verify the authenticity of token of the user
        admin.auth().verifyIdToken(tokenId)
            .then((decodedToken) => {
                //get the user uid if you need it.
               const uid = decodedToken.uid;

                //do your cool stuff that requires authentication of the user here.

            //end of authorization
            })
            .catch((error) => {
                console.log(error);
            });

    //end of cors
    })

//end of function
})
dldeef67

dldeef678#

有一个很好的官方示例,使用Express -将来可能会很方便:https://github.com/firebase/functions-samples/blob/master/authorized-https-endpoint/functions/index.js(粘贴在下面只是为了确定)
请记住,exports.app使您的函数在/app slug下可用(在本例中,只有一个函数在<you-firebase-app>/app/hello下可用)。为了摆脱它,实际上需要重写Express部分(用于验证的中间件部分保持不变-它工作得非常好,并且由于注解而非常容易理解)。

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

wooyq4lh9#

我一直在努力在golang GCP功能中获得适当的firebase身份验证。实际上没有这样的例子,所以我决定建立这个小库:https://github.com/Jblew/go-firebase-auth-in-gcp-functions
现在你可以很容易地使用firebase-auth对用户进行身份验证(这与gcp-authenticated-functions不同,并且不直接由identity-aware-proxy支持)。
下面是使用该实用程序的示例:

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标志(因为firebase身份验证发生在函数执行过程中)。
“我希望这能帮助你,就像它帮助我一样。出于性能原因,我决定使用golang作为云函数 * -Jđdrzej

相关问题