github.com/tickoalcantara12/micro/v3@v3.0.0-20221007104245-9d75b9bcbab9/util/auth/token/token.go (about)

     1  // Copyright 2020 Asim Aslam
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  //
    15  // Original source: github.com/micro/go-micro/v3/util/token/token.go
    16  
    17  package token
    18  
    19  import (
    20  	"errors"
    21  	"time"
    22  
    23  	"github.com/tickoalcantara12/micro/v3/service/auth"
    24  )
    25  
    26  var (
    27  	// ErrNotFound is returned when a token cannot be found
    28  	ErrNotFound = errors.New("token not found")
    29  	// ErrEncodingToken is returned when the service encounters an error during encoding
    30  	ErrEncodingToken = errors.New("error encoding the token")
    31  	// ErrInvalidToken is returned when the token provided is not valid
    32  	ErrInvalidToken = errors.New("invalid token provided")
    33  )
    34  
    35  // Provider generates and inspects tokens
    36  type Provider interface {
    37  	Generate(account *auth.Account, opts ...GenerateOption) (*Token, error)
    38  	Inspect(token string) (*auth.Account, error)
    39  	String() string
    40  }
    41  
    42  type Token struct {
    43  	// The actual token
    44  	Token string `json:"token"`
    45  	// Time of token creation
    46  	Created time.Time `json:"created"`
    47  	// Time of token expiry
    48  	Expiry time.Time `json:"expiry"`
    49  }