带入gRPC：对 RPC 方法做自定义认证

wh469012917 发布于2019-07-01 10:49 / 2029人阅读

摘要：带入对方法做自定义认证原文地址带入对方法做自定义认证项目地址前言在前面的章节中，我们介绍了两种证书算一种可全局认证的方法证书认证基于的证书认证而在实际需求中，常常会对某些模块的方法做特殊认证或校验。

带入gRPC：对 RPC 方法做自定义认证

原文地址：带入gRPC：对 RPC 方法做自定义认证
项目地址：https://github.com/EDDYCJY/go...

前言

在前面的章节中，我们介绍了两种（证书算一种）可全局认证的方法：

TLS 证书认证

基于 CA 的 TLS 证书认证

Unary and Stream interceptor

而在实际需求中，常常会对某些模块的 RPC 方法做特殊认证或校验。今天将会讲解、实现这块的功能点

课前知识

type PerRPCCredentials interface {
    GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)
    RequireTransportSecurity() bool
}

在 gRPC 中默认定义了 PerRPCCredentials，它就是本章节的主角，是 gRPC 默认提供用于自定义认证的接口，它的作用是将所需的安全认证信息添加到每个 RPC 方法的上下文中。其包含 2 个方法：

GetRequestMetadata：获取当前请求认证所需的元数据（metadata）

RequireTransportSecurity：是否需要基于 TLS 认证进行安全传输

目录结构

新建 simple_token_server/server.go 和 simple_token_client/client.go，目录结构如下：

go-grpc-example
├── client
│   ├── simple_client
│   ├── simple_http_client
│   ├── simple_token_client
│   └── stream_client
├── conf
├── pkg
├── proto
├── server
│   ├── simple_http_server
│   ├── simple_server
│   ├── simple_token_server
│   └── stream_server
└── vendor

gRPC Client

package main

import (
    "context"
    "log"

    "google.golang.org/grpc"

    "github.com/EDDYCJY/go-grpc-example/pkg/gtls"
    pb "github.com/EDDYCJY/go-grpc-example/proto"
)

const PORT = "9004"

type Auth struct {
    AppKey    string
    AppSecret string
}

func (a *Auth) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error) {
    return map[string]string{"app_key": a.AppKey, "app_secret": a.AppSecret}, nil
}

func (a *Auth) RequireTransportSecurity() bool {
    return true
}

func main() {
    tlsClient := gtls.Client{
        ServerName: "go-grpc-example",
        CertFile:   "../../conf/server/server.pem",
    }
    c, err := tlsClient.GetTLSCredentials()
    if err != nil {
        log.Fatalf("tlsClient.GetTLSCredentials err: %v", err)
    }

    auth := Auth{
        AppKey:    "eddycjy",
        AppSecret: "20181005",
    }
    conn, err := grpc.Dial(":"+PORT, grpc.WithTransportCredentials(c), grpc.WithPerRPCCredentials(&auth))
    ...
}

在 Client 端，重点实现 type PerRPCCredentials interface 所需的方法，关注两点即可：

struct Auth：GetRequestMetadata、RequireTransportSecurity

grpc.WithPerRPCCredentials

Server

package main

import (
    "context"
    "log"
    "net"

    "google.golang.org/grpc"
    "google.golang.org/grpc/codes"
    "google.golang.org/grpc/metadata"
    "google.golang.org/grpc/status"

    "github.com/EDDYCJY/go-grpc-example/pkg/gtls"
    pb "github.com/EDDYCJY/go-grpc-example/proto"
)

type SearchService struct {
    auth *Auth
}

func (s *SearchService) Search(ctx context.Context, r *pb.SearchRequest) (*pb.SearchResponse, error) {
    if err := s.auth.Check(ctx); err != nil {
        return nil, err
    }
    return &pb.SearchResponse{Response: r.GetRequest() + " Token Server"}, nil
}

const PORT = "9004"

func main() {
    ...
}

type Auth struct {
    appKey    string
    appSecret string
}

func (a *Auth) Check(ctx context.Context) error {
    md, ok := metadata.FromIncomingContext(ctx)
    if !ok {
        return status.Errorf(codes.Unauthenticated, "自定义认证 Token 失败")
    }

    var (
        appKey    string
        appSecret string
    )
    if value, ok := md["app_key"]; ok {
        appKey = value[0]
    }
    if value, ok := md["app_secret"]; ok {
        appSecret = value[0]
    }

    if appKey != a.GetAppKey() || appSecret != a.GetAppSecret() {
        return status.Errorf(codes.Unauthenticated, "自定义认证 Token 无效")
    }

    return nil
}

func (a *Auth) GetAppKey() string {
    return "eddycjy"
}

func (a *Auth) GetAppSecret() string {
    return "20181005"
}

在 Server 端就更简单了，实际就是调用 metadata.FromIncomingContext 从上下文中获取 metadata，再在不同的 RPC 方法中进行认证检查

验证

重新启动 server.go 和 client.go，得到以下结果：

$ go run client.go
2018/10/05 20:59:58 resp: gRPC Token Server

修改 client.go 的值，制造两者不一致，得到无效结果：

$ go run client.go
2018/10/05 21:00:05 client.Search err: rpc error: code = Unauthenticated desc = invalid token
exit status 1

一个个加太麻烦

我相信你肯定会问一个个加，也太麻烦了吧？有这个想法的你，应当把 type PerRPCCredentials interface 做成一个拦截器（interceptor）

总结

本章节比较简单，主要是针对 RPC 方法的自定义认证进行了介绍，如果是想做全局的，建议是举一反三从拦截器下手哦

GPU云服务器云服务器对人工智能定义 grpc 属性定义方法自定义方法

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/29522.html

带入gRPC：gRPC及相关介绍

摘要：带入及相关介绍原文地址带入及相关介绍项目地址作为开篇章，将会介绍相关的一些知识。带入gRPC：gRPC及相关介绍原文地址：带入gRPC：gRPC及相关介绍项目地址：go-grpc-example 作为开篇章，将会介绍 gRPC 相关的一些知识。简单来讲 gRPC 是一个基于 HTTP/2 协议设计的 RPC 框架，它采用了 Protobuf 作为 IDL 你是否有过疑惑，它们都...

AJie 2019-07-01 10:45 评论0 收藏0
带入gRPC：gRPC及相关介绍

摘要：原文地址带入及相关介绍项目地址作为开篇章，将会介绍相关的一些知识。原文地址：带入gRPC：gRPC及相关介绍项目地址：go-grpc-example 作为开篇章，将会介绍 gRPC 相关的一些知识。简单来讲 gRPC 是一个基于 HTTP/2 协议设计的 RPC 框架，它采用了 Protobuf 作为 IDL 你是否有过疑惑，它们都是些什么？本文将会介绍一些常用的知识和概念，更详...

y1chuan 2019-08-26 12:21 评论0 收藏0
带入gRPC：gRPC Streaming, Client and Server

摘要：带入原文地址带入项目地址前言本章节将介绍的流式，分为三种类型服务器端流式客户端流式双向流式流任何技术，因为有痛点，所以才有了存在的必要性。这一次性涉及的数据量确实大在同步完成后，也有人马上会去查阅数据，为了新的一天筹备。带入gRPC：gRPC Streaming, Client and Server 原文地址：带入gRPC：gRPC Streaming, Client and Ser...

wayneli 2019-07-01 10:45 评论0 收藏0
带入gRPC：基于 CA 的 TLS 证书认证

摘要：带入基于的证书认证原文地址带入基于的证书认证项目地址前言在上一章节中，我们提出了一个问题。其遵守标准根证书根证书是属于根证书颁发机构的公钥证书。目标是基于进行认证带入gRPC：基于 CA 的 TLS 证书认证原文地址：带入gRPC：基于 CA 的 TLS 证书认证项目地址：https://github.com/EDDYCJY/go... 前言在上一章节中，我们提出了一个问题。就是...

史占广 2019-07-01 10:47 评论0 收藏0
带入gRPC：分布式链路追踪 gRPC-Opentracing-Zipkin

摘要：带入分布式链路追踪原文地址带入分布式链路追踪项目地址前言在实际应用中，你做了那么多端，写了个方法。想看看方法的指标，却无处下手本文将通过搭建一个分布式链路追踪系统来实现查看整个系统的链路性能等指标带入gRPC：分布式链路追踪 gRPC + Opentracing + Zipkin 原文地址：带入gRPC：分布式链路追踪 gRPC + Opentracing + Zipkin项目地址：...

BicycleWarrior 2019-07-01 10:51 评论0 收藏0