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 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
|
// Copyright (c) Contributors to the Apptainer project, established as
// Apptainer a Series of LF Projects LLC.
// For website terms of use, trademark policy, privacy policy and other
// project policies see https://lfprojects.org/policies
// 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 (
"fmt"
"io"
"os"
"strings"
"github.com/apptainer/apptainer/docs"
"github.com/apptainer/apptainer/internal/app/apptainer"
"github.com/apptainer/apptainer/internal/pkg/client/library"
"github.com/apptainer/apptainer/internal/pkg/remote"
"github.com/apptainer/apptainer/pkg/cmdline"
"github.com/apptainer/apptainer/pkg/syfs"
"github.com/apptainer/apptainer/pkg/sylog"
"github.com/spf13/cobra"
)
const (
remoteWarning = "no authentication token, log in with `apptainer remote login`"
)
var (
loginTokenFile string
loginUsername string
loginPassword string
remoteConfig string
remoteKeyserverOrder uint32
remoteKeyserverInsecure bool
loginPasswordStdin bool
loginInsecure bool
remoteNoLogin bool
global bool
remoteUseExclusive bool
remoteAddInsecure bool
remoteAddNotDefault bool
)
// assemble values of remoteConfig for user/sys locations
var remoteConfigUser = syfs.RemoteConf()
// -g|--global
var remoteGlobalFlag = cmdline.Flag{
ID: "remoteGlobalFlag",
Value: &global,
DefaultValue: false,
Name: "global",
ShortHand: "g",
Usage: "edit the list of globally configured remote endpoints",
}
// -c|--config
var remoteConfigFlag = cmdline.Flag{
ID: "remoteConfigFlag",
Value: &remoteConfig,
DefaultValue: remoteConfigUser,
Name: "config",
ShortHand: "c",
Usage: "path to the file holding remote endpoint configurations",
}
// --tokenfile
var remoteTokenFileFlag = cmdline.Flag{
ID: "remoteTokenFileFlag",
Value: &loginTokenFile,
DefaultValue: "",
Name: "tokenfile",
Usage: "path to the file holding auth token for login (remote endpoints only)",
}
// --no-login
var remoteNoLoginFlag = cmdline.Flag{
ID: "remoteNoLoginFlag",
Value: &remoteNoLogin,
DefaultValue: false,
Name: "no-login",
Usage: "skip automatic login step",
}
// -u|--username
var remoteLoginUsernameFlag = cmdline.Flag{
ID: "remoteLoginUsernameFlag",
Value: &loginUsername,
DefaultValue: "",
Name: "username",
ShortHand: "u",
Usage: "username to authenticate with",
EnvKeys: []string{"LOGIN_USERNAME"},
}
// -p|--password
var remoteLoginPasswordFlag = cmdline.Flag{
ID: "remoteLoginPasswordFlag",
Value: &loginPassword,
DefaultValue: "",
Name: "password",
ShortHand: "p",
Usage: "password / token to authenticate with",
EnvKeys: []string{"LOGIN_PASSWORD"},
}
// --password-stdin
var remoteLoginPasswordStdinFlag = cmdline.Flag{
ID: "remoteLoginPasswordStdinFlag",
Value: &loginPasswordStdin,
DefaultValue: false,
Name: "password-stdin",
Usage: "take password from standard input",
}
// -i|--insecure
var remoteLoginInsecureFlag = cmdline.Flag{
ID: "remoteLoginInsecureFlag",
Value: &loginInsecure,
DefaultValue: false,
Name: "insecure",
ShortHand: "i",
Usage: "allow insecure login",
EnvKeys: []string{"LOGIN_INSECURE"},
}
// -e|--exclusive
var remoteUseExclusiveFlag = cmdline.Flag{
ID: "remoteUseExclusiveFlag",
Value: &remoteUseExclusive,
DefaultValue: false,
Name: "exclusive",
ShortHand: "e",
Usage: "set the endpoint as exclusive (root user only, imply --global)",
}
// -o|--order (deprecated)
var remoteKeyserverOrderFlag = cmdline.Flag{
ID: "remoteKeyserverOrderFlag",
Value: &remoteKeyserverOrder,
DefaultValue: uint32(0),
Name: "order",
ShortHand: "o",
Hidden: true,
}
// -i|--insecure (deprecated)
var remoteKeyserverInsecureFlag = cmdline.Flag{
ID: "remoteKeyserverInsecureFlag",
Value: &remoteKeyserverInsecure,
DefaultValue: false,
Name: "insecure",
ShortHand: "i",
Hidden: true,
}
// -i|--insecure
var remoteAddInsecureFlag = cmdline.Flag{
ID: "remoteAddInsecureFlag",
Value: &remoteAddInsecure,
DefaultValue: false,
Name: "insecure",
ShortHand: "i",
Usage: "allow connection to an insecure http remote.",
EnvKeys: []string{"ADD_INSECURE"},
}
// -i|--insecure
var remoteAddNotDefaultFlag = cmdline.Flag{
ID: "remoteAddNotDefaultFlag",
Value: &remoteAddNotDefault,
DefaultValue: false,
Name: "no-default",
ShortHand: "n",
Usage: "do not designate the newly-added remote endpoint as the default",
}
func init() {
addCmdInit(func(cmdManager *cmdline.CommandManager) {
cmdManager.RegisterCmd(RemoteCmd)
cmdManager.RegisterSubCmd(RemoteCmd, RemoteAddCmd)
cmdManager.RegisterSubCmd(RemoteCmd, RemoteRemoveCmd)
cmdManager.RegisterSubCmd(RemoteCmd, RemoteUseCmd)
cmdManager.RegisterSubCmd(RemoteCmd, RemoteListCmd)
cmdManager.RegisterSubCmd(RemoteCmd, RemoteLoginCmd)
cmdManager.RegisterSubCmd(RemoteCmd, RemoteLogoutCmd)
cmdManager.RegisterSubCmd(RemoteCmd, RemoteStatusCmd)
cmdManager.RegisterSubCmd(RemoteCmd, RemoteAddKeyserverCmd)
cmdManager.RegisterSubCmd(RemoteCmd, RemoteRemoveKeyserverCmd)
cmdManager.RegisterSubCmd(RemoteCmd, RemoteGetLoginPasswordCmd)
// default location of the remote.yaml file is the user directory
cmdManager.RegisterFlagForCmd(&remoteConfigFlag, RemoteCmd)
// use tokenfile to log in to a remote
cmdManager.RegisterFlagForCmd(&remoteTokenFileFlag, RemoteLoginCmd, RemoteAddCmd)
// add --global flag to remote add/remove/use commands
cmdManager.RegisterFlagForCmd(&remoteGlobalFlag, RemoteAddCmd, RemoteRemoveCmd, RemoteUseCmd)
// add --no-login flag to add command
cmdManager.RegisterFlagForCmd(&remoteNoLoginFlag, RemoteAddCmd)
// add --insecure, --no-login flags to add command
cmdManager.RegisterFlagForCmd(&remoteAddInsecureFlag, RemoteAddCmd)
cmdManager.RegisterFlagForCmd(&remoteAddNotDefaultFlag, RemoteAddCmd)
cmdManager.RegisterFlagForCmd(&remoteLoginUsernameFlag, RemoteLoginCmd)
cmdManager.RegisterFlagForCmd(&remoteLoginPasswordFlag, RemoteLoginCmd)
cmdManager.RegisterFlagForCmd(&remoteLoginPasswordStdinFlag, RemoteLoginCmd)
cmdManager.RegisterFlagForCmd(&remoteLoginInsecureFlag, RemoteLoginCmd)
cmdManager.RegisterFlagForCmd(&remoteUseExclusiveFlag, RemoteUseCmd)
cmdManager.RegisterFlagForCmd(&remoteKeyserverOrderFlag, RemoteAddKeyserverCmd)
cmdManager.RegisterFlagForCmd(&remoteKeyserverInsecureFlag, RemoteAddKeyserverCmd)
})
}
// RemoteCmd apptainer remote [...]
var RemoteCmd = &cobra.Command{
Run: nil,
Use: docs.RemoteUse,
Short: docs.RemoteShort,
Long: docs.RemoteLong,
Example: docs.RemoteExample,
DisableFlagsInUseLine: true,
}
// setGlobalRemoteConfig will assign the appropriate value to remoteConfig if the global flag is set
func setGlobalRemoteConfig(_ *cobra.Command, _ []string) {
if !global {
return
}
uid := uint32(os.Getuid())
if uid != 0 {
sylog.Fatalf("Unable to modify global endpoint configuration file: not root user")
}
// set remoteConfig value to the location of the global remote.yaml file
remoteConfig = remote.SystemConfigPath
}
// RemoteGetLoginPasswordCmd apptainer remote get-login-password
var RemoteGetLoginPasswordCmd = &cobra.Command{
DisableFlagsInUseLine: true,
Use: docs.RemoteGetLoginPasswordUse,
Short: docs.RemoteGetLoginPasswordShort,
Long: docs.RemoteGetLoginPasswordLong,
Example: docs.RemoteGetLoginPasswordExample,
Run: func(_ *cobra.Command, _ []string) {
defaultConfig := ""
config, err := getLibraryClientConfig(defaultConfig)
if err != nil {
sylog.Errorf("Error initializing config: %v", err)
}
password, err := library.GetOCIToken(config)
if err != nil {
sylog.Errorf("error: %v", err)
}
if password != "" {
fmt.Println(password)
}
},
}
// RemoteAddCmd apptainer remote add [remoteName] [remoteURI]
var RemoteAddCmd = &cobra.Command{
Args: cobra.ExactArgs(2),
PreRun: setGlobalRemoteConfig,
Run: func(_ *cobra.Command, args []string) {
name := args[0]
uri := args[1]
localInsecure := remoteAddInsecure
if strings.HasPrefix(uri, "https://") {
sylog.Infof("--insecure ignored for https remote")
localInsecure = false
}
if strings.HasPrefix(uri, "http://") && !localInsecure {
sylog.Fatalf("http URI requires --insecure or APPTAINER_ADD_INSECURE=true")
}
makeDefault := !remoteAddNotDefault
if err := apptainer.RemoteAdd(remoteConfig, name, uri, global, localInsecure, makeDefault); err != nil {
sylog.Fatalf("%s", err)
}
sylog.Infof("Remote %q added.", name)
// ensure that this was not called with global flag, otherwise this will store the token in the
// world readable config
if global && !remoteNoLogin {
sylog.Infof("Global option detected. Will not automatically log into remote.")
} else if !remoteNoLogin {
loginArgs := &apptainer.LoginArgs{
Name: name,
Tokenfile: loginTokenFile,
ReqAuthFile: reqAuthFile,
}
if err := apptainer.RemoteLogin(remoteConfig, loginArgs); err != nil {
sylog.Fatalf("%s", err)
}
}
},
Use: docs.RemoteAddUse,
Short: docs.RemoteAddShort,
Long: docs.RemoteAddLong,
Example: docs.RemoteAddExample,
DisableFlagsInUseLine: true,
}
// RemoteRemoveCmd apptainer remote remove [remoteName]
var RemoteRemoveCmd = &cobra.Command{
Args: cobra.ExactArgs(1),
PreRun: setGlobalRemoteConfig,
Run: func(_ *cobra.Command, args []string) {
name := args[0]
if err := apptainer.RemoteRemove(remoteConfig, name); err != nil {
sylog.Fatalf("%s", err)
}
sylog.Infof("Remote %q removed.", name)
},
Use: docs.RemoteRemoveUse,
Short: docs.RemoteRemoveShort,
Long: docs.RemoteRemoveLong,
Example: docs.RemoteRemoveExample,
DisableFlagsInUseLine: true,
}
// RemoteUseCmd apptainer remote use [remoteName]
var RemoteUseCmd = &cobra.Command{
Args: cobra.ExactArgs(1),
PreRun: setGlobalRemoteConfig,
Run: func(_ *cobra.Command, args []string) {
name := args[0]
if err := apptainer.RemoteUse(remoteConfig, name, global, remoteUseExclusive); err != nil {
sylog.Fatalf("%s", err)
}
sylog.Infof("Remote %q now in use.", name)
},
Use: docs.RemoteUseUse,
Short: docs.RemoteUseShort,
Long: docs.RemoteUseLong,
Example: docs.RemoteUseExample,
DisableFlagsInUseLine: true,
}
// RemoteListCmd apptainer remote list
var RemoteListCmd = &cobra.Command{
Args: cobra.ExactArgs(0),
Run: func(_ *cobra.Command, _ []string) {
if err := apptainer.RemoteList(remoteConfig); err != nil {
sylog.Fatalf("%s", err)
}
},
Use: docs.RemoteListUse,
Short: docs.RemoteListShort,
Long: docs.RemoteListLong,
Example: docs.RemoteListExample,
DisableFlagsInUseLine: true,
}
// RemoteLoginCmd apptainer remote login [remoteName]
var RemoteLoginCmd = &cobra.Command{
Args: cobra.RangeArgs(0, 1),
Run: func(_ *cobra.Command, args []string) {
loginArgs := new(apptainer.LoginArgs)
// default to empty string to signal to RemoteLogin to use default remote
if len(args) > 0 {
loginArgs.Name = args[0]
}
loginArgs.Username = loginUsername
loginArgs.Password = loginPassword
loginArgs.Tokenfile = loginTokenFile
loginArgs.Insecure = loginInsecure
loginArgs.ReqAuthFile = reqAuthFile
if loginPasswordStdin {
p, err := io.ReadAll(os.Stdin)
if err != nil {
sylog.Fatalf("Failed to read password from stdin: %s", err)
}
loginArgs.Password = strings.TrimSuffix(string(p), "\n")
loginArgs.Password = strings.TrimSuffix(loginArgs.Password, "\r")
}
if err := apptainer.RemoteLogin(remoteConfig, loginArgs); err != nil {
sylog.Fatalf("%s", err)
}
},
Use: docs.RemoteLoginUse,
Short: docs.RemoteLoginShort,
Long: docs.RemoteLoginLong,
Example: docs.RemoteLoginExample,
DisableFlagsInUseLine: true,
}
// RemoteLogoutCmd apptainer remote logout [remoteName|serviceURI]
var RemoteLogoutCmd = &cobra.Command{
Args: cobra.RangeArgs(0, 1),
Run: func(_ *cobra.Command, args []string) {
// default to empty string to signal to RemoteLogin to use default remote
name := ""
if len(args) > 0 {
name = args[0]
}
if err := apptainer.RemoteLogout(remoteConfig, name); err != nil {
sylog.Fatalf("%s", err)
}
sylog.Infof("Logout succeeded")
},
Use: docs.RemoteLogoutUse,
Short: docs.RemoteLogoutShort,
Long: docs.RemoteLogoutLong,
Example: docs.RemoteLogoutExample,
DisableFlagsInUseLine: true,
}
// RemoteStatusCmd apptainer remote status [remoteName]
var RemoteStatusCmd = &cobra.Command{
Args: cobra.RangeArgs(0, 1),
Run: func(_ *cobra.Command, args []string) {
// default to empty string to signal to RemoteStatus to use default remote
name := ""
if len(args) > 0 {
name = args[0]
}
if err := apptainer.RemoteStatus(remoteConfig, name); err != nil {
sylog.Fatalf("%s", err)
}
},
Use: docs.RemoteStatusUse,
Short: docs.RemoteStatusShort,
Long: docs.RemoteStatusLong,
Example: docs.RemoteStatusExample,
DisableFlagsInUseLine: true,
}
// RemoteAddKeyserverCmd apptainer remote add-keyserver (deprecated)
var RemoteAddKeyserverCmd = &cobra.Command{
Args: cobra.RangeArgs(1, 2),
Run: func(cmd *cobra.Command, args []string) {
sylog.Warningf("'remote add-keyserver' is deprecated and will be removed in a future release; running 'keyserver add'")
keyserverInsecure = remoteKeyserverInsecure
keyserverOrder = remoteKeyserverOrder
KeyserverAddCmd.Run(cmd, args)
},
Use: "add-keyserver",
Hidden: true,
}
// RemoteAddKeyserverCmd apptainer remote remove-keyserver (deprecated)
var RemoteRemoveKeyserverCmd = &cobra.Command{
Args: cobra.RangeArgs(1, 2),
Run: func(cmd *cobra.Command, args []string) {
sylog.Warningf("'remote remove-keyserver' is deprecated and will be removed in a future release; running 'keyserver remove'")
KeyserverRemoveCmd.Run(cmd, args)
},
Use: "remove-keyserver",
Hidden: true,
}
|