blob: 1e5821616bd4a579575f263851995be545540f77 [file] [log] [blame]
// Copyright 2019 The LUCI Authors.
// 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
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package projectscope
import (
bqpb ""
func init() {
bq.RegisterTokenKind("project_tokens", (*bqpb.ProjectToken)(nil))
// MintedTokenInfo is passed to LogToken.
// It carries all information about the token minting operation and the produced
// token.
type MintedTokenInfo struct {
Request *minter.MintProjectTokenRequest // RPC input, as is
Response *minter.MintProjectTokenResponse // RPC output, as is
RequestedAt *timestamppb.Timestamp
Expiration *timestamppb.Timestamp
PeerIdentity identity.Identity // caller identity
PeerIP net.IP // caller IP address
RequestID string // GAE request ID that handled the RPC
AuthDBRev int64 // revision of groups database (or 0 if unknown)
// toBigQueryMessage returns a message to upload to BigQuery.
func (i *MintedTokenInfo) toBigQueryMessage() *bqpb.ProjectToken {
return &bqpb.ProjectToken{
// Information about the produced token.
Fingerprint: utils.TokenFingerprint(i.Response.AccessToken),
ServiceAccount: i.Response.ServiceAccountEmail,
OauthScopes: i.Request.OauthScope,
LuciProject: i.Request.LuciProject,
ServiceIdentity: i.PeerIdentity.Email(),
RequestedAt: i.RequestedAt,
Expiration: i.Expiration,
AuditTags: i.Request.AuditTags,
PeerIp: i.PeerIP.String(),
ServiceVersion: i.Response.ServiceVersion,
GaeRequestId: i.RequestID,
AuthDbRev: i.AuthDBRev,
// TokenLogger records info about the token to BigQuery.
type TokenLogger func(context.Context, *MintedTokenInfo) error
// NewTokenLogger returns a callback that records info about tokens to BigQuery.
// Tokens themselves are not logged. Only first 16 bytes of their SHA256 hashes
// (aka 'fingerprint') are. They are used only to identify tokens in logs.
// When dryRun is true, logs to the local text log only, not to BigQuery
// (to avoid accidentally pushing fake data to real BigQuery dataset).
func NewTokenLogger(dryRun bool) TokenLogger {
return func(ctx context.Context, i *MintedTokenInfo) error {
return bq.LogToken(ctx, i.toBigQueryMessage(), dryRun)