// Copyright IBM Corp. 2020, 2025 // SPDX-License-Identifier: BUSL-1.1 package authtoken import ( "context" "time" "github.com/hashicorp/boundary/globals" "github.com/hashicorp/boundary/internal/errors" "github.com/hashicorp/boundary/internal/listtoken" "github.com/hashicorp/boundary/internal/pagination" "github.com/hashicorp/boundary/internal/types/resource" ) // ListRefresh lists up to page size auth tokens, filtering out entries that // do not pass the filter item function. It will automatically request // more auth tokens from the database, at page size chunks, to fill the page. // It will start its paging based on the information in the token. // It returns a new list token used to continue pagination or refresh items. // Auth tokens are ordered by update time descending (most recently updated first). // Auth tokens may contain items that were already returned during the initial // pagination phase. It also returns a list of any auth tokens deleted since the // start of the initial pagination phase or last response. func ListRefresh( ctx context.Context, grantsHash []byte, pageSize int, filterItemFn pagination.ListFilterFunc[*AuthToken], tok *listtoken.Token, repo *Repository, withScopeIds []string, ) (*pagination.ListResponse[*AuthToken], error) { const op = "authtoken.ListRefresh" switch { case len(grantsHash) == 0: return nil, errors.New(ctx, errors.InvalidParameter, op, "missing grants hash") case pageSize < 1: return nil, errors.New(ctx, errors.InvalidParameter, op, "page size must be at least 1") case filterItemFn == nil: return nil, errors.New(ctx, errors.InvalidParameter, op, "missing filter item callback") case tok == nil: return nil, errors.New(ctx, errors.InvalidParameter, op, "missing token") case repo == nil: return nil, errors.New(ctx, errors.InvalidParameter, op, "missing repo") case withScopeIds == nil: return nil, errors.New(ctx, errors.InvalidParameter, op, "missing scope ids") case tok.ResourceType != resource.AuthToken: return nil, errors.New(ctx, errors.InvalidParameter, op, "token did not have an auth token resource type") } rt, ok := tok.Subtype.(*listtoken.StartRefreshToken) if !ok { return nil, errors.New(ctx, errors.InvalidParameter, op, "token did not have a start-refresh token component") } listItemsFn := func(ctx context.Context, lastPageItem *AuthToken, limit int) ([]*AuthToken, time.Time, error) { opts := []Option{ WithLimit(limit), } if lastPageItem != nil { opts = append(opts, WithStartPageAfterItem(lastPageItem)) } // Add the database read timeout to account for any creations missed due to concurrent // transactions in the initial pagination phase. return repo.listAuthTokensRefresh(ctx, rt.PreviousPhaseUpperBound.Add(-globals.RefreshReadLookbackDuration), withScopeIds, opts...) } listDeletedIdsFn := func(ctx context.Context, since time.Time) ([]string, time.Time, error) { // Add the database read timeout to account for any deletions missed due to concurrent // transactions in previous requests. return repo.listDeletedIds(ctx, since.Add(-globals.RefreshReadLookbackDuration)) } return pagination.ListRefresh(ctx, grantsHash, pageSize, filterItemFn, listItemsFn, repo.estimatedCount, listDeletedIdsFn, tok) }