forgejo-terraform-provider/forgejo/resource_gitea_token.go

package forgejo

import (
	"fmt"
	"strconv"

	"codeberg.org/mvdkleijn/forgejo-sdk/forgejo/v2"
	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)

const (
	TokenName      string = "name"
	TokenHash      string = "token"
	TokenLastEight string = "last_eight"
	TokenScopes    string = "scopes"
)

// validScopes contains the valid scopes for tokens as listed
// at https://docs.forgejo.com/development/oauth2-provider#scopes
var validScopes = map[string]bool{
	"all":                true,
	"read:activitypub":   true,
	"write:activitypub":  true,
	"read:admin":         true,
	"write:admin":        true,
	"read:issue":         true,
	"write:issue":        true,
	"read:misc":          true,
	"write:misc":         true,
	"read:notification":  true,
	"write:notification": true,
	"read:organization":  true,
	"write:organization": true,
	"read:package":       true,
	"write:package":      true,
	"read:repository":    true,
	"write:repository":   true,
	"read:user":          true,
	"write:user":         true,
}

func searchTokenById(c *forgejo.Client, id int64) (res *forgejo.AccessToken, err error) {
	page := 1

	for {
		tokens, _, err := c.ListAccessTokens(forgejo.ListAccessTokensOptions{
			ListOptions: forgejo.ListOptions{
				Page:     page,
				PageSize: 50,
			},
		})
		if err != nil {
			return nil, err
		}

		if len(tokens) == 0 {
			return nil, fmt.Errorf("Token with ID %d could not be found", id)
		}

		for _, token := range tokens {
			if token.ID == id {
				return token, nil
			}
		}

		page += 1
	}
}

func resourceTokenCreate(d *schema.ResourceData, meta interface{}) (err error) {

	client := meta.(*forgejo.Client)

	// Create a list of valid scopes. Thrown an error if an invalid scope is found
	var scopes []forgejo.AccessTokenScope
	for _, s := range d.Get(TokenScopes).(*schema.Set).List() {
		s := s.(string)
		if validScopes[s] {
			scopes = append(scopes, forgejo.AccessTokenScope(s))
		} else {
			return fmt.Errorf("Invalid token scope: '%s'", s)
		}
	}

	opts := forgejo.CreateAccessTokenOption{
		Name:   d.Get(TokenName).(string),
		Scopes: scopes,
	}

	token, _, err := client.CreateAccessToken(opts)

	if err != nil {
		return err
	}

	err = setTokenResourceData(token, d)

	return
}

func resourceTokenRead(d *schema.ResourceData, meta interface{}) (err error) {

	client := meta.(*forgejo.Client)

	var token *forgejo.AccessToken

	id, err := strconv.ParseInt(d.Id(), 10, 64)

	token, err = searchTokenById(client, id)

	if err != nil {
		return err
	}

	err = setTokenResourceData(token, d)

	return
}

func resourceTokenDelete(d *schema.ResourceData, meta interface{}) (err error) {

	client := meta.(*forgejo.Client)
	var resp *forgejo.Response

	resp, err = client.DeleteAccessToken(d.Get(TokenName).(string))

	if err != nil {
		if resp.StatusCode == 404 {
			return
		} else {
			return err
		}
	}

	return
}

func setTokenResourceData(token *forgejo.AccessToken, d *schema.ResourceData) (err error) {

	d.SetId(fmt.Sprintf("%d", token.ID))
	d.Set(TokenName, token.Name)
	if token.Token != "" {
		d.Set(TokenHash, token.Token)
	}
	d.Set(TokenLastEight, token.TokenLastEight)
	d.Set(TokenScopes, token.Scopes)

	return
}

func resourceGiteaToken() *schema.Resource {
	return &schema.Resource{
		Read:   resourceTokenRead,
		Create: resourceTokenCreate,
		Delete: resourceTokenDelete,
		Importer: &schema.ResourceImporter{
			StateContext: schema.ImportStatePassthroughContext,
		},
		Schema: map[string]*schema.Schema{
			"name": {
				Type:        schema.TypeString,
				Required:    true,
				ForceNew:    true,
				Description: "The name of the Access Token",
			},
			"token": {
				Type:        schema.TypeString,
				Computed:    true,
				Sensitive:   true,
				Description: "The actual Access Token",
			},
			"last_eight": {
				Type:     schema.TypeString,
				Computed: true,
			},
			"scopes": {
				Type: schema.TypeSet,
				Elem: &schema.Schema{
					Type: schema.TypeString,
				},
				Required:    true,
				ForceNew:    true,
				Description: "List of string representations of scopes for the token",
			},
		},
		Description: "`forgejo_token` manages forgejo Access Tokens.\n\n" +
			"Due to upstream limitations (see https://forgejo.com/forgejo/go-sdk/issues/610) this resource\n" +
			"can only be used with username/password provider configuration.\n\n" +
			"WARNING:\n" +
			"Tokens will be stored in the terraform state!",
	}
}