1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
|
// Copyright (c) 2019-2023, Sylabs Inc. All rights reserved.
// Copyright (c) 2020, Control Command Inc. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package cli
import (
"os"
"github.com/spf13/cobra"
"github.com/sylabs/singularity/v4/docs"
"github.com/sylabs/singularity/v4/internal/app/singularity"
"github.com/sylabs/singularity/v4/pkg/cmdline"
"github.com/sylabs/singularity/v4/pkg/sylog"
)
var (
keyserverInsecure bool
keyserverOrder uint32
)
// -c|--config
var keyserverConfigFlag = cmdline.Flag{
ID: "keyserverConfigFlag",
Value: &remoteConfig,
DefaultValue: remoteConfigUser,
Name: "config",
ShortHand: "c",
Usage: "path to the file holding keyserver configurations",
}
// -i|--insecure
var keyserverInsecureFlag = cmdline.Flag{
ID: "keyserverInsecureFlag",
Value: &keyserverInsecure,
DefaultValue: false,
Name: "insecure",
ShortHand: "i",
Usage: "allow insecure connection to keyserver",
}
// -o|--order
var keyserverOrderFlag = cmdline.Flag{
ID: "keyserverOrderFlag",
Value: &keyserverOrder,
DefaultValue: uint32(0),
Name: "order",
ShortHand: "o",
Usage: "define the keyserver order",
}
// -u|--username
var keyserverLoginUsernameFlag = cmdline.Flag{
ID: "keyserverLoginUsernameFlag",
Value: &loginUsername,
DefaultValue: "",
Name: "username",
ShortHand: "u",
Usage: "username to authenticate with (required for Docker/OCI registry login)",
EnvKeys: []string{"LOGIN_USERNAME"},
}
// -p|--password
var keyserverLoginPasswordFlag = cmdline.Flag{
ID: "keyserverLoginPasswordFlag",
Value: &loginPassword,
DefaultValue: "",
Name: "password",
ShortHand: "p",
Usage: "password / token to authenticate with",
EnvKeys: []string{"LOGIN_PASSWORD"},
}
// --password-stdin
var keyserverLoginPasswordStdinFlag = cmdline.Flag{
ID: "keyserverLoginPasswordStdinFlag",
Value: &loginPasswordStdin,
DefaultValue: false,
Name: "password-stdin",
Usage: "take password from standard input",
}
func init() {
addCmdInit(func(cmdManager *cmdline.CommandManager) {
cmdManager.RegisterCmd(KeyserverCmd)
cmdManager.RegisterSubCmd(KeyserverCmd, KeyserverAddCmd)
cmdManager.RegisterSubCmd(KeyserverCmd, KeyserverRemoveCmd)
cmdManager.RegisterSubCmd(KeyserverCmd, KeyserverLoginCmd)
cmdManager.RegisterSubCmd(KeyserverCmd, KeyserverLogoutCmd)
cmdManager.RegisterSubCmd(KeyserverCmd, KeyserverListCmd)
// default location of the remote.yaml file is the user directory
cmdManager.RegisterFlagForCmd(&keyserverConfigFlag, KeyserverCmd)
cmdManager.RegisterFlagForCmd(&keyserverOrderFlag, KeyserverAddCmd)
cmdManager.RegisterFlagForCmd(&keyserverInsecureFlag, KeyserverAddCmd)
cmdManager.RegisterFlagForCmd(&keyserverLoginUsernameFlag, KeyserverLoginCmd)
cmdManager.RegisterFlagForCmd(&keyserverLoginPasswordFlag, KeyserverLoginCmd)
cmdManager.RegisterFlagForCmd(&keyserverLoginPasswordStdinFlag, KeyserverLoginCmd)
})
}
// KeyserverCmd singularity keyserver [...]
var KeyserverCmd = &cobra.Command{
Run: nil,
Use: docs.KeyserverUse,
Short: docs.KeyserverShort,
Long: docs.KeyserverLong,
Example: docs.KeyserverExample,
DisableFlagsInUseLine: true,
}
// KeyserverAddCmd singularity keyserver add [option] <keyserver_url>
var KeyserverAddCmd = &cobra.Command{
Args: cobra.RangeArgs(1, 2),
PreRun: setKeyserver,
Run: func(cmd *cobra.Command, args []string) {
uri := args[0]
name := ""
if len(args) > 1 {
name = args[0]
uri = args[1]
}
if cmd.Flag(keyserverOrderFlag.Name).Changed && keyserverOrder == 0 {
sylog.Fatalf("order must be > 0")
}
if err := singularity.KeyserverAdd(name, uri, keyserverOrder, keyserverInsecure); err != nil {
sylog.Fatalf("%s", err)
}
},
Use: docs.KeyserverAddUse,
Short: docs.KeyserverAddShort,
Long: docs.KeyserverAddLong,
Example: docs.KeyserverAddExample,
DisableFlagsInUseLine: true,
}
// KeyserverRemoveCmd singularity remote remove-keyserver [remoteName] <keyserver_url>
var KeyserverRemoveCmd = &cobra.Command{
Args: cobra.RangeArgs(1, 2),
PreRun: setKeyserver,
Run: func(cmd *cobra.Command, args []string) {
uri := args[0]
name := ""
if len(args) > 1 {
name = args[0]
uri = args[1]
}
if err := singularity.KeyserverRemove(name, uri); err != nil {
sylog.Fatalf("%s", err)
}
},
Use: docs.KeyserverRemoveUse,
Short: docs.KeyserverRemoveShort,
Long: docs.KeyserverRemoveLong,
Example: docs.KeyserverRemoveExample,
DisableFlagsInUseLine: true,
}
func setKeyserver(_ *cobra.Command, _ []string) {
if uint32(os.Getuid()) != 0 {
sylog.Fatalf("Unable to modify keyserver configuration: not root user")
}
}
// KeyserverLoginCmd singularity registry login [option] <registry_url>
var KeyserverLoginCmd = &cobra.Command{
Args: cobra.ExactArgs(1),
Run: func(cmd *cobra.Command, args []string) {
if err := singularity.KeyserverLogin(remoteConfig, ObtainLoginArgs(args[0])); err != nil {
sylog.Fatalf("%s", err)
}
},
Use: docs.KeyserverLoginUse,
Short: docs.KeyserverLoginShort,
Long: docs.KeyserverLoginLong,
Example: docs.KeyserverLoginExample,
DisableFlagsInUseLine: true,
}
// KeyserverLogoutCmd singularity remote logout [remoteName|serviceURI]
var KeyserverLogoutCmd = &cobra.Command{
Args: cobra.RangeArgs(0, 1),
Run: func(cmd *cobra.Command, args []string) {
// default to empty string to signal to KeyserverLogin to use default remote
name := ""
if len(args) > 0 {
name = args[0]
}
if err := singularity.KeyserverLogout(remoteConfig, name); err != nil {
sylog.Fatalf("%s", err)
}
sylog.Infof("Logout succeeded")
},
Use: docs.KeyserverLogoutUse,
Short: docs.KeyserverLogoutShort,
Long: docs.KeyserverLogoutLong,
Example: docs.KeyserverLogoutExample,
DisableFlagsInUseLine: true,
}
// KeyserverListCmd singularity remote list
var KeyserverListCmd = &cobra.Command{
Args: cobra.RangeArgs(0, 1),
Run: func(cmd *cobra.Command, args []string) {
remoteName := ""
if len(args) > 0 {
remoteName = args[0]
}
if err := singularity.KeyserverList(remoteName, remoteConfig); err != nil {
sylog.Fatalf("%s", err)
}
},
Use: docs.KeyserverListUse,
Short: docs.KeyserverListShort,
Long: docs.KeyserverListLong,
Example: docs.KeyserverListExample,
DisableFlagsInUseLine: true,
}
|