Skip to content

Refactor createtree command #788

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
merged 4 commits into from
Aug 11, 2017
Merged

Refactor createtree command #788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
16f72af
Add flagsaver package
Jul 10, 2017
2d8b534
Refactor cmd/createtree to use flags directly
Jul 26, 2017
1fb8070
Move fakeAdminServer into a testonly package
Aug 10, 2017
26f59cf
Change createtree's default signature algorithm from RSA to ECDSA
Aug 10, 2017
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
102 changes: 36 additions & 66 deletions cmd/createtree/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ import (
"flag"
"fmt"
"io/ioutil"
"os"
"time"

"github.com/golang/glog"
"github.com/golang/protobuf/ptypes"
Expand All @@ -57,7 +55,7 @@ var (
treeType = flag.String("tree_type", trillian.TreeType_LOG.String(), "Type of the new tree")
hashStrategy = flag.String("hash_strategy", trillian.HashStrategy_RFC6962_SHA256.String(), "Hash strategy (aka preimage protection) of the new tree")
hashAlgorithm = flag.String("hash_algorithm", sigpb.DigitallySigned_SHA256.String(), "Hash algorithm of the new tree")
signatureAlgorithm = flag.String("signature_algorithm", sigpb.DigitallySigned_RSA.String(), "Signature algorithm of the new tree")
signatureAlgorithm = flag.String("signature_algorithm", sigpb.DigitallySigned_ECDSA.String(), "Signature algorithm of the new tree")
displayName = flag.String("display_name", "", "Display name of the new tree")
description = flag.String("description", "", "Description of the new tree")
maxRootDuration = flag.Duration("max_root_duration", 0, "Interval after which a new signed root is produced despite no submissions; zero means never")
Expand All @@ -70,26 +68,17 @@ var (
configFile = flag.String("config", "", "Config file containing flags, file contents can be overridden by command line flags")
)

// createOpts contains all user-supplied options required to run the program.
// It's meant to facilitate tests and focus flag reads to a single point.
type createOpts struct {
addr string
treeState, treeType, hashStrategy, hashAlgorithm, sigAlgorithm, displayName, description string
maxRootDuration time.Duration
privateKeyType, pemKeyPath, pemKeyPass, pkcs11ConfigPath string
}

func createTree(ctx context.Context, opts *createOpts) (*trillian.Tree, error) {
if opts.addr == "" {
func createTree(ctx context.Context) (*trillian.Tree, error) {
if *adminServerAddr == "" {
return nil, errors.New("empty --admin_server, please provide the Admin server host:port")
}

req, err := newRequest(opts)
req, err := newRequest()
if err != nil {
return nil, err
}

conn, err := grpc.Dial(opts.addr, grpc.WithInsecure())
conn, err := grpc.Dial(*adminServerAddr, grpc.WithInsecure())
if err != nil {
return nil, err
}
Expand All @@ -102,30 +91,30 @@ func createTree(ctx context.Context, opts *createOpts) (*trillian.Tree, error) {
return tree, nil
}

func newRequest(opts *createOpts) (*trillian.CreateTreeRequest, error) {
ts, ok := trillian.TreeState_value[opts.treeState]
func newRequest() (*trillian.CreateTreeRequest, error) {
ts, ok := trillian.TreeState_value[*treeState]
if !ok {
return nil, fmt.Errorf("unknown TreeState: %v", opts.treeState)
return nil, fmt.Errorf("unknown TreeState: %v", *treeState)
}

tt, ok := trillian.TreeType_value[opts.treeType]
tt, ok := trillian.TreeType_value[*treeType]
if !ok {
return nil, fmt.Errorf("unknown TreeType: %v", opts.treeType)
return nil, fmt.Errorf("unknown TreeType: %v", *treeType)
}

hs, ok := trillian.HashStrategy_value[opts.hashStrategy]
hs, ok := trillian.HashStrategy_value[*hashStrategy]
if !ok {
return nil, fmt.Errorf("unknown HashStrategy: %v", opts.hashStrategy)
return nil, fmt.Errorf("unknown HashStrategy: %v", *hashStrategy)
}

ha, ok := sigpb.DigitallySigned_HashAlgorithm_value[opts.hashAlgorithm]
ha, ok := sigpb.DigitallySigned_HashAlgorithm_value[*hashAlgorithm]
if !ok {
return nil, fmt.Errorf("unknown HashAlgorithm: %v", opts.hashAlgorithm)
return nil, fmt.Errorf("unknown HashAlgorithm: %v", *hashAlgorithm)
}

sa, ok := sigpb.DigitallySigned_SignatureAlgorithm_value[opts.sigAlgorithm]
sa, ok := sigpb.DigitallySigned_SignatureAlgorithm_value[*signatureAlgorithm]
if !ok {
return nil, fmt.Errorf("unknown SignatureAlgorithm: %v", opts.sigAlgorithm)
return nil, fmt.Errorf("unknown SignatureAlgorithm: %v", *signatureAlgorithm)
}

ctr := &trillian.CreateTreeRequest{Tree: &trillian.Tree{
Expand All @@ -134,13 +123,13 @@ func newRequest(opts *createOpts) (*trillian.CreateTreeRequest, error) {
HashStrategy: trillian.HashStrategy(hs),
HashAlgorithm: sigpb.DigitallySigned_HashAlgorithm(ha),
SignatureAlgorithm: sigpb.DigitallySigned_SignatureAlgorithm(sa),
DisplayName: opts.displayName,
Description: opts.description,
MaxRootDuration: ptypes.DurationProto(opts.maxRootDuration),
DisplayName: *displayName,
Description: *description,
MaxRootDuration: ptypes.DurationProto(*maxRootDuration),
}}

if opts.privateKeyType != "" {
pk, err := newPK(opts)
if *privateKeyFormat != "" {
pk, err := newPK(*privateKeyFormat)
if err != nil {
return nil, err
}
Expand All @@ -149,7 +138,7 @@ func newRequest(opts *createOpts) (*trillian.CreateTreeRequest, error) {
// Cannot continue if options specifying a key were provided but
// privateKeyType is not set, as there's no way to know what protobuf
// message type was intended.
if opts.pemKeyPath != "" || opts.pemKeyPass != "" || opts.pkcs11ConfigPath != "" {
if *pemKeyPath != "" || *pemKeyPassword != "" || *pkcs11ConfigPath != "" {
return nil, errors.New("must specify private key format")
}

Expand All @@ -173,26 +162,26 @@ func newRequest(opts *createOpts) (*trillian.CreateTreeRequest, error) {
return ctr, nil
}

func newPK(opts *createOpts) (*any.Any, error) {
switch opts.privateKeyType {
func newPK(keyFormat string) (*any.Any, error) {
switch keyFormat {
case "PEMKeyFile":
if opts.pemKeyPath == "" {
if *pemKeyPath == "" {
return nil, errors.New("empty pem_key_path")
}
if opts.pemKeyPass == "" {
return nil, fmt.Errorf("empty password for PEM key file %q", opts.pemKeyPath)
if *pemKeyPassword == "" {
return nil, fmt.Errorf("empty password for PEM key file %q", *pemKeyPath)
}
pemKey := &keyspb.PEMKeyFile{
Path: opts.pemKeyPath,
Password: opts.pemKeyPass,
Path: *pemKeyPath,
Password: *pemKeyPassword,
}
return ptypes.MarshalAny(pemKey)
case "PrivateKey":
if opts.pemKeyPath == "" {
if *pemKeyPath == "" {
return nil, errors.New("empty pem_key_path")
}
pemSigner, err := keys.NewFromPrivatePEMFile(
opts.pemKeyPath, opts.pemKeyPass)
*pemKeyPath, *pemKeyPassword)
if err != nil {
return nil, err
}
Expand All @@ -202,10 +191,10 @@ func newPK(opts *createOpts) (*any.Any, error) {
}
return ptypes.MarshalAny(&keyspb.PrivateKey{Der: der})
case "PKCS11ConfigFile":
if opts.pkcs11ConfigPath == "" {
if *pkcs11ConfigPath == "" {
return nil, errors.New("empty PKCS11 config file path")
}
configBytes, err := ioutil.ReadFile(opts.pkcs11ConfigPath)
configBytes, err := ioutil.ReadFile(*pkcs11ConfigPath)
if err != nil {
return nil, err
}
Expand All @@ -223,25 +212,7 @@ func newPK(opts *createOpts) (*any.Any, error) {
PublicKey: string(pubKeyBytes),
})
default:
return nil, fmt.Errorf("unknown private key type: %v", opts.privateKeyType)
}
}

func newOptsFromFlags() *createOpts {
return &createOpts{
addr: *adminServerAddr,
treeState: *treeState,
treeType: *treeType,
hashStrategy: *hashStrategy,
hashAlgorithm: *hashAlgorithm,
sigAlgorithm: *signatureAlgorithm,
displayName: *displayName,
description: *description,
maxRootDuration: *maxRootDuration,
privateKeyType: *privateKeyFormat,
pemKeyPath: *pemKeyPath,
pemKeyPass: *pemKeyPassword,
pkcs11ConfigPath: *pkcs11ConfigPath,
return nil, fmt.Errorf("unknown private key type: %v", keyFormat)
}
}

Expand All @@ -255,10 +226,9 @@ func main() {
}

ctx := context.Background()
tree, err := createTree(ctx, newOptsFromFlags())
tree, err := createTree(ctx)
if err != nil {
fmt.Fprintf(os.Stderr, "Failed to create tree: %v\n", err)
os.Exit(1)
glog.Exitf("Failed to create tree: %v", err)
}

// DO NOT change the output format, scripts are meant to depend on it.
Expand Down
Loading