mirror of
				https://codeberg.org/forgejo/forgejo.git
				synced 2025-11-04 00:11:04 +00:00 
			
		
		
		
	urfave/cli v2 will eventually become unmaintained, switch over to v3 which is the latest supported version. Note: the `docs` command would be a lot of work to restore with v3 ([the package is still in alpha](https://github.com/urfave/cli-docs)) An alternative to avoid a breaking change would be to not upgrade from v2 to v3 for that reason alone. Note: these commits were cherry-picked from https://code.forgejo.org/forgefriends/forgefriends Note: it is best reviewed side by side with no display of whitespace changes (there are a lot of those when converting vars to func). - a few functional changes were necessary and are noted in context in the file changes tab - https://cli.urfave.org/migrate-v2-to-v3/ upgrade instructions were followed in the most minimal way possible - upgrade gof3 to v3.10.8 which includes and upgrade from urfave/cli v2 to urfave/cli v3 - upgrade gitlab.com/gitlab-org/api/client-go v0.129.0 because it is an indirect dependency of gof3 and requires a change because of a deprecated field that otherwise triggers a lint error but nothing else otherwise - verified that the [script](https://codeberg.org/forgejo/docs/src/branch/next/scripts/cli-docs.sh) that generates the [CLI documentation](https://codeberg.org/forgejo/docs/src/branch/next/scripts/cli-docs.sh) still works. There are cosmetic differences and the **help** subcommand is no longer advertised (although it is still supported) but the `--help` option is advertised as expected so it is fine. - end-to-end tests [passed](https://code.forgejo.org/forgejo/end-to-end/pulls/667) (they use the Forgejo CLI to some extent) ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] I do not want this change to show in the release notes. - [ ] I want the title to show in the release notes with a link to this pull request. - [x] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Breaking features - [PR](https://codeberg.org/forgejo/forgejo/pulls/8035): <!--number 8035 --><!--line 0 --><!--description VGhlIGBmb3JnZWpvIGRvY3NgIGNvbW1hbmQgaXMgZGVwcmVjYXRlZCBhbmQgQ0xJIGVycm9ycyBhcmUgbm93IGRpc3BsYXllZCBvbiBzdGRlcnIgaW5zdGVhZCBvZiBzdGRvdXQuIFRoZXNlIGJyZWFraW5nIGNoYW5nZXMgaGFwcGVuZWQgYmVjYXVzZSB0aGUgcGFja2FnZSB1c2VkIHRvIHBhcnNlIHRoZSBjb21tYW5kIGxpbmUgYXJndW1lbnRzIHdhcyBbdXBncmFkZWQgZnJvbSB2MiB0byB2M10oaHR0cHM6Ly9jbGkudXJmYXZlLm9yZy9taWdyYXRlLXYyLXRvLXYzLykuIEEgW3NlcGFyYXRlIHByb2plY3Qgd2FzIGluaXRpYXRlZF0oaHR0cHM6Ly9naXRodWIuY29tL3VyZmF2ZS9jbGktZG9jcykgdG8gcmUtaW1wbGVtZW50IHRoZSBgZG9jc2AgY29tbWFuZCwgYnV0IGl0IGlzIG5vdCB5ZXQgcHJvZHVjdGlvbiByZWFkeS4=-->The `forgejo docs` command is deprecated and CLI errors are now displayed on stderr instead of stdout. These breaking changes happened because the package used to parse the command line arguments was [upgraded from v2 to v3](https://cli.urfave.org/migrate-v2-to-v3/). A [separate project was initiated](https://github.com/urfave/cli-docs) to re-implement the `docs` command, but it is not yet production ready.<!--description--> <!--end release-notes-assistant--> Co-authored-by: limiting-factor <limiting-factor@posteo.com> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/8035 Reviewed-by: Gusted <gusted@noreply.codeberg.org>
		
			
				
	
	
		
			199 lines
		
	
	
	
		
			5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			199 lines
		
	
	
	
		
			5 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// Copyright 2009 The Go Authors. All rights reserved.
 | 
						|
// Copyright 2014 The Gogs Authors. All rights reserved.
 | 
						|
// Copyright 2016 The Gitea Authors. All rights reserved.
 | 
						|
// SPDX-License-Identifier: MIT
 | 
						|
 | 
						|
package cmd
 | 
						|
 | 
						|
import (
 | 
						|
	"context"
 | 
						|
	"crypto/ecdsa"
 | 
						|
	"crypto/elliptic"
 | 
						|
	"crypto/rand"
 | 
						|
	"crypto/rsa"
 | 
						|
	"crypto/x509"
 | 
						|
	"crypto/x509/pkix"
 | 
						|
	"encoding/pem"
 | 
						|
	"log"
 | 
						|
	"math/big"
 | 
						|
	"net"
 | 
						|
	"os"
 | 
						|
	"strings"
 | 
						|
	"time"
 | 
						|
 | 
						|
	"github.com/urfave/cli/v3"
 | 
						|
)
 | 
						|
 | 
						|
// CmdCert represents the available cert sub-command.
 | 
						|
func cmdCert() *cli.Command {
 | 
						|
	return &cli.Command{
 | 
						|
		Name:  "cert",
 | 
						|
		Usage: "Generate self-signed certificate",
 | 
						|
		Description: `Generate a self-signed X.509 certificate for a TLS server.
 | 
						|
Outputs to 'cert.pem' and 'key.pem' and will overwrite existing files.`,
 | 
						|
		Action: runCert,
 | 
						|
		Flags: []cli.Flag{
 | 
						|
			&cli.StringFlag{
 | 
						|
				Name:  "host",
 | 
						|
				Value: "",
 | 
						|
				Usage: "Comma-separated hostnames and IPs to generate a certificate for",
 | 
						|
			},
 | 
						|
			&cli.StringFlag{
 | 
						|
				Name:  "ecdsa-curve",
 | 
						|
				Value: "",
 | 
						|
				Usage: "ECDSA curve to use to generate a key. Valid values are P224, P256, P384, P521",
 | 
						|
			},
 | 
						|
			&cli.IntFlag{
 | 
						|
				Name:  "rsa-bits",
 | 
						|
				Value: 3072,
 | 
						|
				Usage: "Size of RSA key to generate. Ignored if --ecdsa-curve is set",
 | 
						|
			},
 | 
						|
			&cli.StringFlag{
 | 
						|
				Name:  "start-date",
 | 
						|
				Value: "",
 | 
						|
				Usage: "Creation date formatted as Jan 1 15:04:05 2011",
 | 
						|
			},
 | 
						|
			&cli.DurationFlag{
 | 
						|
				Name:  "duration",
 | 
						|
				Value: 365 * 24 * time.Hour,
 | 
						|
				Usage: "Duration that certificate is valid for",
 | 
						|
			},
 | 
						|
			&cli.BoolFlag{
 | 
						|
				Name:  "ca",
 | 
						|
				Usage: "whether this cert should be its own Certificate Authority",
 | 
						|
			},
 | 
						|
		},
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func publicKey(priv any) any {
 | 
						|
	switch k := priv.(type) {
 | 
						|
	case *rsa.PrivateKey:
 | 
						|
		return &k.PublicKey
 | 
						|
	case *ecdsa.PrivateKey:
 | 
						|
		return &k.PublicKey
 | 
						|
	default:
 | 
						|
		return nil
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func pemBlockForKey(priv any) *pem.Block {
 | 
						|
	switch k := priv.(type) {
 | 
						|
	case *rsa.PrivateKey:
 | 
						|
		return &pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(k)}
 | 
						|
	case *ecdsa.PrivateKey:
 | 
						|
		b, err := x509.MarshalECPrivateKey(k)
 | 
						|
		if err != nil {
 | 
						|
			log.Fatalf("Unable to marshal ECDSA private key: %v", err)
 | 
						|
		}
 | 
						|
		return &pem.Block{Type: "EC PRIVATE KEY", Bytes: b}
 | 
						|
	default:
 | 
						|
		return nil
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func runCert(ctx context.Context, c *cli.Command) error {
 | 
						|
	if err := argsSet(c, "host"); err != nil {
 | 
						|
		return err
 | 
						|
	}
 | 
						|
 | 
						|
	var priv any
 | 
						|
	var err error
 | 
						|
	switch c.String("ecdsa-curve") {
 | 
						|
	case "":
 | 
						|
		priv, err = rsa.GenerateKey(rand.Reader, c.Int("rsa-bits"))
 | 
						|
	case "P224":
 | 
						|
		priv, err = ecdsa.GenerateKey(elliptic.P224(), rand.Reader)
 | 
						|
	case "P256":
 | 
						|
		priv, err = ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
 | 
						|
	case "P384":
 | 
						|
		priv, err = ecdsa.GenerateKey(elliptic.P384(), rand.Reader)
 | 
						|
	case "P521":
 | 
						|
		priv, err = ecdsa.GenerateKey(elliptic.P521(), rand.Reader)
 | 
						|
	default:
 | 
						|
		log.Fatalf("Unrecognized elliptic curve: %q", c.String("ecdsa-curve"))
 | 
						|
	}
 | 
						|
	if err != nil {
 | 
						|
		log.Fatalf("Failed to generate private key: %v", err)
 | 
						|
	}
 | 
						|
 | 
						|
	var notBefore time.Time
 | 
						|
	if startDate := c.String("start-date"); startDate != "" {
 | 
						|
		notBefore, err = time.Parse("Jan 2 15:04:05 2006", startDate)
 | 
						|
		if err != nil {
 | 
						|
			log.Fatalf("Failed to parse creation date: %v", err)
 | 
						|
		}
 | 
						|
	} else {
 | 
						|
		notBefore = time.Now()
 | 
						|
	}
 | 
						|
 | 
						|
	notAfter := notBefore.Add(c.Duration("duration"))
 | 
						|
 | 
						|
	serialNumberLimit := new(big.Int).Lsh(big.NewInt(1), 128)
 | 
						|
	serialNumber, err := rand.Int(rand.Reader, serialNumberLimit)
 | 
						|
	if err != nil {
 | 
						|
		log.Fatalf("Failed to generate serial number: %v", err)
 | 
						|
	}
 | 
						|
 | 
						|
	template := x509.Certificate{
 | 
						|
		SerialNumber: serialNumber,
 | 
						|
		Subject: pkix.Name{
 | 
						|
			Organization: []string{"Acme Co"},
 | 
						|
			CommonName:   "Forgejo",
 | 
						|
		},
 | 
						|
		NotBefore: notBefore,
 | 
						|
		NotAfter:  notAfter,
 | 
						|
 | 
						|
		KeyUsage:              x509.KeyUsageKeyEncipherment | x509.KeyUsageDigitalSignature,
 | 
						|
		ExtKeyUsage:           []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth},
 | 
						|
		BasicConstraintsValid: true,
 | 
						|
	}
 | 
						|
 | 
						|
	hosts := strings.Split(c.String("host"), ",")
 | 
						|
	for _, h := range hosts {
 | 
						|
		if ip := net.ParseIP(h); ip != nil {
 | 
						|
			template.IPAddresses = append(template.IPAddresses, ip)
 | 
						|
		} else {
 | 
						|
			template.DNSNames = append(template.DNSNames, h)
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
	if c.Bool("ca") {
 | 
						|
		template.IsCA = true
 | 
						|
		template.KeyUsage |= x509.KeyUsageCertSign
 | 
						|
	}
 | 
						|
 | 
						|
	derBytes, err := x509.CreateCertificate(rand.Reader, &template, &template, publicKey(priv), priv)
 | 
						|
	if err != nil {
 | 
						|
		log.Fatalf("Failed to create certificate: %v", err)
 | 
						|
	}
 | 
						|
 | 
						|
	certOut, err := os.Create("cert.pem")
 | 
						|
	if err != nil {
 | 
						|
		log.Fatalf("Failed to open cert.pem for writing: %v", err)
 | 
						|
	}
 | 
						|
	err = pem.Encode(certOut, &pem.Block{Type: "CERTIFICATE", Bytes: derBytes})
 | 
						|
	if err != nil {
 | 
						|
		log.Fatalf("Failed to encode certificate: %v", err)
 | 
						|
	}
 | 
						|
	err = certOut.Close()
 | 
						|
	if err != nil {
 | 
						|
		log.Fatalf("Failed to write cert: %v", err)
 | 
						|
	}
 | 
						|
	log.Println("Written cert.pem")
 | 
						|
 | 
						|
	keyOut, err := os.OpenFile("key.pem", os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o600)
 | 
						|
	if err != nil {
 | 
						|
		log.Fatalf("Failed to open key.pem for writing: %v", err)
 | 
						|
	}
 | 
						|
	err = pem.Encode(keyOut, pemBlockForKey(priv))
 | 
						|
	if err != nil {
 | 
						|
		log.Fatalf("Failed to encode key: %v", err)
 | 
						|
	}
 | 
						|
	err = keyOut.Close()
 | 
						|
	if err != nil {
 | 
						|
		log.Fatalf("Failed to write key: %v", err)
 | 
						|
	}
 | 
						|
	log.Println("Written key.pem")
 | 
						|
	return nil
 | 
						|
}
 |