Skip to content

Client changes for tbot IoT joining #10397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timothyb89 merged 12 commits into from
Feb 18, 2022
Merged

Client changes for tbot IoT joining #10397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
2becedc
client changes
nklaassen Feb 16, 2022
39d7a82
delete replaced APIs
nklaassen Feb 16, 2022
d50118b
delete unused tbot/auth.go
nklaassen Feb 16, 2022
b7dfbcb
add license header
nklaassen Feb 16, 2022
9697638
don't unecessarily fetch host CA
nklaassen Feb 16, 2022
87104a7
log fixes
nklaassen Feb 17, 2022
4000f92
s/tunnelling/tunneling/
nklaassen Feb 18, 2022
66c85b4
auth server addresses may be proxies
nklaassen Feb 18, 2022
ab5b34e
comment typo fix
nklaassen Feb 18, 2022
329afcd
Merge branch 'nklaassen/tbot-join' into nklaassen/tbot-join-client
nklaassen Feb 18, 2022
c0c019c
Merge branch 'nklaassen/tbot-join' into nklaassen/tbot-join-client
timothyb89 Feb 18, 2022
a0ea5ea
move *Server methods out of auth_with_roles.go (#10416)
nklaassen Feb 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 0 additions & 11 deletions api/client/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -723,17 +723,6 @@ func (c *Client) GetBotUsers(ctx context.Context) ([]types.User, error) {
return users, nil
}

// GenerateInitialRenewableUserCerts exchanges a bot token for a set of
// renewable user certificates.
func (c *Client) GenerateInitialRenewableUserCerts(ctx context.Context, req *proto.RenewableCertsRequest) (*proto.Certs, error) {
certs, err := c.grpc.GenerateInitialRenewableUserCerts(ctx, req, c.callOpts...)
if err != nil {
return nil, trail.FromGRPC(err)
}

return certs, nil
}

// GetAccessRequests retrieves a list of all access requests matching the provided filter.
func (c *Client) GetAccessRequests(ctx context.Context, filter types.AccessRequestFilter) ([]types.AccessRequest, error) {
rsp, err := c.grpc.GetAccessRequests(ctx, &filter, c.callOpts...)
Expand Down
1,197 changes: 578 additions & 619 deletions api/client/proto/authservice.pb.go
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 0 additions & 3 deletions api/client/proto/authservice.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1668,9 +1668,6 @@ service AuthService {
rpc DeleteBot(DeleteBotRequest) returns (google.protobuf.Empty);
// GetBotUsers gets all users with bot labels.
rpc GetBotUsers(GetBotUsersRequest) returns (stream types.UserV2);
// GenerateInitialRenewableUserCerts generates an initial set of renewable
// certificates using a bot token.
rpc GenerateInitialRenewableUserCerts(RenewableCertsRequest) returns (Certs);

// GetUser gets a user resource by name.
rpc GetUser(GetUserRequest) returns (types.UserV2);
Expand Down
243 changes: 0 additions & 243 deletions lib/auth/auth_with_roles.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,9 @@ package auth

import (
"context"
"fmt"
"net/url"
"strconv"
"time"

"github.com/google/uuid"
"github.com/gravitational/teleport"
"github.com/gravitational/teleport/api/client"
"github.com/gravitational/teleport/api/client/proto"
Expand Down Expand Up @@ -1649,116 +1646,6 @@ func (a *ServerWithRoles) NewKeepAliver(ctx context.Context) (types.KeepAliver,
return nil, trace.NotImplemented(notImplementedMessage)
}

// TODO(nic): Delete this, auth.RegisterUsing(Token|IAMMethod) is used instead
// GenerateInitialRenewableUserCerts generates renewable certs for a non-interactive user
// using a previously issued single-use token.
//
// The token's TTL is enforced, and if the operation is successful the token is destroyed.
func (a *ServerWithRoles) GenerateInitialRenewableUserCerts(ctx context.Context, req proto.RenewableCertsRequest) (*proto.Certs, error) {
if len(req.Token) == 0 {
return nil, trace.BadParameter("missing token")
}
if len(req.PublicKey) == 0 {
return nil, trace.BadParameter("missing public key")
}

token, err := a.authServer.GetUserToken(ctx, req.Token)
if err != nil {
log.Debugf("Could not fetch bot token: %+v", err)
return nil, trace.AccessDenied("the token is not valid")
}

if err := a.authServer.verifyUserToken(token, UserTokenTypeBot); err != nil {
return nil, trace.Wrap(err)
}

// TODO: consider allowing scoping to a specific SSH node with NodeName and Usage
expires := a.authServer.GetClock().Now().Add(defaults.DefaultRenewableCertTTL)

// Generate the initial set of user certificates.
certs, err := a.authServer.generateInitialRenewableUserCerts(ctx, token.GetUser(), req.PublicKey, expires)
if err != nil {
return nil, trace.Wrap(err)
}

if err := a.authServer.DeleteUserToken(ctx, req.Token); err != nil {
log.Warnf("could not delete user token %v after generating certs: %v",
backend.MaskKeyName(req.Token), err)
}

return certs, nil
}

// TODO(nic): move this to lib/auth/bot.go, leaving it here to keep a minimal diff
// generateInitialRenewableUserCerts is used to generate renewable bot certs
// and overlaps significantly with `generateUserCerts()`. However, it omits a
// number of options (impersonation, access requests, role requests, actual
// cert renewal, and most UserCertsRequest options that don't relate to bots)
// and does not care if the current identity is Nop.
// This function does not validate the current identity at all; the caller is
// expected to validate that the client is allowed to issue the renewable
// certificates.
func (a *Server) generateInitialRenewableUserCerts(ctx context.Context, username string, pubKey []byte, expires time.Time) (*proto.Certs, error) {
var err error

// Extract the user and role set for whom the certificate will be generated.
// This should be safe since this is typically done against a local user.
//
// This call bypasses RBAC check for users read on purpose.
// Users who are allowed to impersonate other users might not have
// permissions to read user data.
user, err := a.GetUser(username, false)
if err != nil {
log.WithError(err).Debugf("Could not impersonate user %v. The user could not be fetched from local store.", username)
return nil, trace.AccessDenied("access denied")
}

// Do not allow SSO users to be impersonated.
if user.GetCreatedBy().Connector != nil {
log.Warningf("Tried to issue a renewable cert for externally managed user %v, this is not supported.", username)
return nil, trace.AccessDenied("access denied")
}

// Cap the cert TTL to the MaxRenewableCertTTL.
if max := a.GetClock().Now().Add(defaults.MaxRenewableCertTTL); expires.After(max) {
expires = max
}

// Inherit the user's roles and traits verbatim.
roles := user.GetRoles()
traits := user.GetTraits()

parsedRoles, err := services.FetchRoleList(roles, a, traits)
if err != nil {
return nil, trace.Wrap(err)
}
// add implicit roles to the set and build a checker
checker := services.NewRoleSet(parsedRoles...)

// Generate certificate
certReq := certRequest{
user: user,
ttl: expires.Sub(a.GetClock().Now()),
publicKey: pubKey,
checker: checker,
traits: user.GetTraits(),
renewable: true,
includeHostCA: true,
generation: 1,
}

if err := a.validateGenerationLabel(ctx, user, &certReq, 0); err != nil {
return nil, trace.Wrap(err)
}

certs, err := a.generateUserCert(certReq)
if err != nil {
return nil, trace.Wrap(err)
}

return certs, nil
}

// determineDesiredRolesAndTraits inspects the current request to determine
// which roles and traits the requesting user wants to be present on the
// resulting certificate. This does not attempt to determine if the
Expand Down Expand Up @@ -1809,136 +1696,6 @@ func (a *ServerWithRoles) GenerateUserCerts(ctx context.Context, req proto.UserC
return a.generateUserCerts(ctx, req)
}

// TODO(nic): move this to lib/auth/bot.go, leaving it here to keep a minimal diff
// validateGenerationLabel validates and updates a generation label.
func (a *Server) validateGenerationLabel(ctx context.Context, user types.User, certReq *certRequest, currentIdentityGeneration uint64) error {
// Fetch the user, bypassing the cache. We might otherwise fetch a stale
// value in case of a rapid certificate renewal.
user, err := a.Identity.GetUser(user.GetName(), false)
if err != nil {
return trace.Wrap(err)
}

var currentUserGeneration uint64
label, labelOk := user.GetMetadata().Labels[types.BotGenerationLabel]
if labelOk {
currentUserGeneration, err = strconv.ParseUint(label, 10, 64)
if err != nil {
return trace.BadParameter("user has invalid value for label %q", types.BotGenerationLabel)
}
}

// If there is no existing generation on any of the user, identity, or
// cert request, we have nothing to do here.
if currentUserGeneration == 0 && currentIdentityGeneration == 0 && certReq.generation == 0 {
return nil
}

certReq.includeHostCA = true

// If the certReq already has generation set, it was explicitly requested
// (presumably this is the initial set of renewable certs). We'll want to
// commit that value to the User object.
if certReq.generation > 0 {
// ...however, if the user already has a stored generation, bail.
// (bots should be deleted and recreated if their certs expire)
if currentUserGeneration > 0 {
return trace.BadParameter(
"user %q has already been issued a renewable certificate and cannot be issued another; consider deleting and recreating the bot",
user.GetName(),
)
}

// Fetch a fresh copy of the user we can mutate safely. We can't
// implement a protobuf clone on User due to protobuf's proto.Clone()
// panicing when the user object has traits set, and a JSON
// marshal/unmarshal creates an import cycle so... here we are.
// There's a tiny chance the underlying user is mutated between calls
// to GetUser() but we're comparing with an older value so it'll fail
// safely.
newUser, err := a.Identity.GetUser(user.GetName(), false)
if err != nil {
return trace.Wrap(err)
}
metadata := newUser.GetMetadata()
metadata.Labels[types.BotGenerationLabel] = fmt.Sprint(certReq.generation)
newUser.SetMetadata(metadata)

// Note: we bypass the RBAC check on purpose as bot users should not
// have user update permissions.
if err := a.CompareAndSwapUser(ctx, newUser, user); err != nil {
// If this fails it's likely to be some miscellaneous competing
// write. The request should be tried again - if it's malicious,
// someone will get a generation mismatch and trigger a lock.
return trace.WrapWithMessage(err, "Database comparison failed, try the request again")
}

return nil
}

// By now, we know a generation counter is in play _somewhere_. The current
// generations must match to continue:
if currentIdentityGeneration != currentUserGeneration {
// Lock the bot user indefinitely.
lock, err := types.NewLock(uuid.New().String(), types.LockSpecV2{
Target: types.LockTarget{
User: user.GetName(),
},
Message: fmt.Sprintf(
"The bot user %q has been locked due to a certificate generation mismatch, possibly indicating a stolen certificate.",
user.GetName(),
),
})
if err != nil {
return trace.Wrap(err)
}
if err := a.UpsertLock(context.Background(), lock); err != nil {
return trace.Wrap(err)
}

// Emit an audit event.
userMetadata := ClientUserMetadata(ctx)
if a.emitter.EmitAuditEvent(a.closeCtx, &apievents.RenewableCertificateGenerationMismatch{
Metadata: apievents.Metadata{
Type: events.RenewableCertificateGenerationMismatchEvent,
Code: events.RenewableCertificateGenerationMismatchCode,
},
UserMetadata: userMetadata,
}); err != nil {
log.WithError(err).Warn("Failed to emit renewable cert generation mismatch event")
}

return trace.AccessDenied(
"renewable cert generation mismatch: stored=%v, presented=%v",
currentUserGeneration, currentIdentityGeneration,
)
}

// Update the user with the new generation count.
newGeneration := currentIdentityGeneration + 1

// As above, commit some crimes to clone the User.
newUser, err := a.Identity.GetUser(user.GetName(), false)
if err != nil {
return trace.Wrap(err)
}
metadata := newUser.GetMetadata()
metadata.Labels[types.BotGenerationLabel] = fmt.Sprint(newGeneration)
newUser.SetMetadata(metadata)

if err := a.CompareAndSwapUser(ctx, newUser, user); err != nil {
// If this fails it's likely to be some miscellaneous competing
// write. The request should be tried again - if it's malicious,
// someone will get a generation mismatch and trigger a lock.
return trace.WrapWithMessage(err, "Database comparison failed, try the request again")
}

// And lastly, set the generation on the cert request.
certReq.generation = newGeneration

return nil
}

func (a *ServerWithRoles) generateUserCerts(ctx context.Context, req proto.UserCertsRequest, opts ...certRequestOption) (*proto.Certs, error) {
var err error

Expand Down
Loading