gRPC Authorization in Go
В сервисе gRPC каждый вызов указывает полный метод, например /library.v1.BookService/DeleteBook. Это упрощает авторизацию на уровне методов: определите, какие роли могут вызывать какие методы, и проверяйте это в серверном перехватчике перед запуском обработчика. В этом руководстве мы сделаем это на Go с помощью Casbin для унарных и потоковых вызовов.
1. Определите сервис
Пример представляет собой небольшой библиотечный сервис. Сохраните следующий код как proto/library/v1/library.proto:
syntax = "proto3";
package library.v1;
option go_package = "example.com/library/gen/library/v1;libraryv1";
service BookService {
rpc GetBook(GetBookRequest) returns (Book);
rpc CreateBook(CreateBookRequest) returns (Book);
rpc DeleteBook(DeleteBookRequest) returns (DeleteBookResponse);
}
message Book {
string id = 1;
string title = 2;
}
message GetBookRequest {
string id = 1;
}
message CreateBookRequest {
string title = 1;
}
message DeleteBookRequest {
string id = 1;
}
message DeleteBookResponse {}
Сгенерируйте код на Go с помощью protoc (или buf generate):
go mod init example.com/library
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
protoc -Iproto --go_out=. --go_opt=module=example.com/library --go-grpc_out=. --go-grpc_opt=module=example.com/library proto/library/v1/library.proto
go get github.com/casbin/casbin/v3 google.golang.org/grpc
2. Напишите модель
Сохраните следующий код как model.conf:
[request_definition]
r = sub, method
[policy_definition]
p = sub, method
[role_definition]
g = _, _
[policy_effect]
e = some(where (p.eft == allow))
[matchers]
m = g(r.sub, p.sub) && keyMatch(r.method, p.method)
r = sub, method: каждый запрос состоит из вызывающей стороны и полного имени метода gRPC.g = _, _: вызывающим сторонам можно назначать роли, а ролям — другие роли.keyMatchпозволяет правилу заканчиваться символом*, поэтому одна строка может покрывать все методы сервиса.
3. Напишите политику
Сохраните следующую конфигурацию как policy.csv:
p, reader, /library.v1.BookService/GetBook
p, librarian, /library.v1.BookService/CreateBook
p, admin, /library.v1.BookService/*
g, librarian, reader
g, admin, librarian
g, alice, admin
g, bob, librarian
g, carol, reader
Роль reader может вызывать GetBook, роль librarian также может вызывать CreateBook, а роль admin может вызывать любой метод BookService, включая методы, добавленные позже. Строки g между ролями создают иерархию, поэтому каждая роль перечисляет только то, что является новым на её уровне.
4. Напишите перехватчики
package main
import (
"context"
"github.com/casbin/casbin/v3"
"google.golang.org/grpc"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
)
// authorize asks Casbin whether the caller may invoke fullMethod, such as /library.v1.BookService/DeleteBook.
func authorize(ctx context.Context, e *casbin.Enforcer, fullMethod string) error {
// Replace this with the identity from your authentication layer,
// such as a verified JWT in the "authorization" metadata or the client's mTLS certificate.
md, _ := metadata.FromIncomingContext(ctx)
users := md.Get("x-user")
if len(users) == 0 {
return status.Error(codes.Unauthenticated, "missing user")
}
allowed, err := e.Enforce(users[0], fullMethod)
if err != nil {
return status.Error(codes.Internal, err.Error())
}
if !allowed {
return status.Errorf(codes.PermissionDenied, "%s may not call %s", users[0], fullMethod)
}
return nil
}
func UnaryAuthz(e *casbin.Enforcer) grpc.UnaryServerInterceptor {
return func(ctx context.Context, req any, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (any, error) {
if err := authorize(ctx, e, info.FullMethod); err != nil {
return nil, err
}
return handler(ctx, req)
}
}
func StreamAuthz(e *casbin.Enforcer) grpc.StreamServerInterceptor {
return func(srv any, ss grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error {
if err := authorize(ss.Context(), e, info.FullMethod); err != nil {
return err
}
return handler(srv, ss)
}
}
Неаутентифицированные вызывающие стороны получают ошибку Unauthenticated, а аутентифицированные вызывающие стороны без соответствующих разрешений получают ошибку PermissionDenied, что соответствует ожиданиям клиентов и шлюзов gRPC.
Метаданные x-user используются в примере для краткости. Casbin отвечает только за авторизацию. В реальном сервисе проверяйте токен из метаданных authorization или берите идентификатор из клиентского сертификата с помощью peer.FromContext при использовании mTLS. Если перехватчик аутентификации уже выполняет эту задачу, подключите его перед перехватчиком авторизации.
5. Зарегистрируйте их на сервере
package main
import (
"context"
"log"
"net"
"github.com/casbin/casbin/v3"
"google.golang.org/grpc"
libraryv1 "example.com/library/gen/library/v1"
)
type bookService struct {
libraryv1.UnimplementedBookServiceServer
}
func (bookService) GetBook(ctx context.Context, req *libraryv1.GetBookRequest) (*libraryv1.Book, error) {
return &libraryv1.Book{Id: req.GetId(), Title: "The Go Programming Language"}, nil
}
func (bookService) CreateBook(ctx context.Context, req *libraryv1.CreateBookRequest) (*libraryv1.Book, error) {
return &libraryv1.Book{Id: "2", Title: req.GetTitle()}, nil
}
func (bookService) DeleteBook(ctx context.Context, req *libraryv1.DeleteBookRequest) (*libraryv1.DeleteBookResponse, error) {
return &libraryv1.DeleteBookResponse{}, nil
}
func main() {
e, err := casbin.NewEnforcer("model.conf", "policy.csv")
if err != nil {
log.Fatal(err)
}
s := grpc.NewServer(
grpc.ChainUnaryInterceptor(UnaryAuthz(e)),
grpc.ChainStreamInterceptor(StreamAuthz(e)),
)
libraryv1.RegisterBookServiceServer(s, bookService{})
lis, err := net.Listen("tcp", ":50051")
if err != nil {
log.Fatal(err)
}
log.Fatal(s.Serve(lis))
}
grpc.ChainUnaryInterceptor и grpc.ChainStreamInterceptor принимают несколько перехватчиков, поэтому рядом с проверкой авторизации можно добавить логирование, метрики и аутентификацию.
6. Попробуйте
Запустите сервер:
go run ./server
Этот клиент вызывает каждый метод от имени четырех разных пользователей:
package main
import (
"context"
"fmt"
"log"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/metadata"
"google.golang.org/grpc/status"
libraryv1 "example.com/library/gen/library/v1"
)
func main() {
conn, err := grpc.NewClient("localhost:50051", grpc.WithTransportCredentials(insecure.NewCredentials()))
if err != nil {
log.Fatal(err)
}
defer conn.Close()
client := libraryv1.NewBookServiceClient(conn)
for _, user := range []string{"alice", "bob", "carol", "dave"} {
ctx := metadata.AppendToOutgoingContext(context.Background(), "x-user", user)
_, getErr := client.GetBook(ctx, &libraryv1.GetBookRequest{Id: "1"})
_, createErr := client.CreateBook(ctx, &libraryv1.CreateBookRequest{Title: "New book"})
_, deleteErr := client.DeleteBook(ctx, &libraryv1.DeleteBookRequest{Id: "1"})
fmt.Printf("%-6s GetBook=%-16v CreateBook=%-16v DeleteBook=%v\n", user,
status.Code(getErr), status.Code(createErr), status.Code(deleteErr))
}
}
go run ./client
alice GetBook=OK CreateBook=OK DeleteBook=OK
bob GetBook=OK CreateBook=OK DeleteBook=PermissionDenied
carol GetBook=OK CreateBook=PermissionDenied DeleteBook=PermissionDenied
dave GetBook=PermissionDenied CreateBook=PermissionDenied DeleteBook=PermissionDenied
С помощью grpcurl передавайте пользователя через заголовок: grpcurl -plaintext -H "x-user: bob" ....
Дальнейшие шаги
- Публичные методы. Проверки состояния и отражение сервера обычно не требуют участия пользователя. Выполняйте ранний вы ход в начале функции
authorizeдля таких случаев, напримерif strings.HasPrefix(fullMethod, "/grpc.health.v1.Health/") { return nil }. - Правила на уровне записей. Перехватчик видит имя метода до запуска обработчика. Правила, зависящие от конкретной записи, такие как «библиотекари могут удалять только книги из своего филиала», следует размещать в обработчике после загрузки записи; см. руководство по ABAC.
- Многопользовательские сервисы. Передавайте идентификатор тенанта из метаданных в качестве третьего аргумента и используйте RBAC с доменами.
- Храните политику в базе данных. Замените
policy.csvна адаптер и добавьте наблюдателя, если несколько реплик обслуживают один и тот же сервис. - HTTP API. Для REST-эндпоинтов на Go см. RBAC в Go с Gin.
Comments are powered by giscus and GitHub Discussions. They load from giscus.app and GitHub only after you click the button below.