Skip to content

Improve mtc help page #62

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
bwesterb merged 2 commits into from
Apr 23, 2025
Merged

Improve mtc help page #62

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7193ba3
Improve mtc help page
bwesterb Apr 23, 2025
79cd9da
Luke's suggestions on #62
bwesterb Apr 23, 2025
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
56 changes: 41 additions & 15 deletions cmd/mtc/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
package main

import (
"errors"
"maps"
"slices"

"github.com/bwesterb/mtc"
"github.com/bwesterb/mtc/ca"
"github.com/bwesterb/mtc/mirror"
"github.com/bwesterb/mtc/umbilical"
"github.com/bwesterb/mtc/umbilical/frozencas"
"github.com/urfave/cli/v2"
"golang.org/x/crypto/cryptobyte"

"bufio"
"crypto/x509"
"encoding/hex"
"encoding/pem"
"errors"
"fmt"
"io"
"maps"
"net"
"os"
"runtime/pprof"
"slices"
"strings"
"text/tabwriter"
"time"

"github.com/bwesterb/mtc"
"github.com/bwesterb/mtc/ca"
"github.com/bwesterb/mtc/mirror"
"github.com/bwesterb/mtc/umbilical"
"github.com/bwesterb/mtc/umbilical/frozencas"

"github.com/urfave/cli/v2"
"golang.org/x/crypto/cryptobyte"
)

var (
Expand Down Expand Up @@ -1085,8 +1086,30 @@ func handleInspectCaParams(cc *cli.Context) error {
return nil
}

var appDescription = strings.TrimSpace(`
This utility provides various functions to work with Merkle Tree Certificates.
See http://github.com/bwesterb/mtc/ for an introduction.

Commands under "mtc ca" are used to manage a Merkle Tree CA.
"mtc ca new" creates a CA. "mtc ca queue" queues an assertion to be
certified. "mtc ca issue" issues a batch. See "mtc ca -h" for more
commands and info.

Commands under "mtc mirror" are used to manage a mirror of a Merkle Tree CA.
"mtc mirror new" sets up a new mirror and "mtc mirror update" syncs it
with the upstream CA. See "mtc mirror -h" for more commands and info.

Commands under "mtc inspect" allow you to investigate the contents
of Merkle Tree Certificates and various other files present in a CA / mirror.

With "mtc new-assertion-request" you can create a request for a new
Merkle Tree Certificate that can be sent to a CA.
`)

func main() {
app := &cli.App{
Usage: "Merkle Tree Certificates utility",
Description: appDescription,
Flags: []cli.Flag{
&cli.StringFlag{
Name: "cpuprofile",
Expand All @@ -1095,7 +1118,8 @@ func main() {
},
Commands: []*cli.Command{
{
Name: "ca",
Name: "ca",
Usage: "manage CA",
Flags: []cli.Flag{
&cli.StringFlag{
Name: "ca-path",
Expand Down Expand Up @@ -1206,7 +1230,8 @@ func main() {
},
},
{
Name: "mirror",
Name: "mirror",
Usage: "manage mirror of a CA",
Flags: []cli.Flag{
&cli.StringFlag{
Name: "mirror-path",
Expand Down Expand Up @@ -1244,7 +1269,8 @@ func main() {
},
},
{
Name: "inspect",
Name: "inspect",
Usage: "inspect various MTC related binary files",
Subcommands: []*cli.Command{
{
Name: "ca-params",
Expand Down