myproxy-retrieve(1)

💖 myproxy-retrieve(1) — the MyProxy girlies' guide 💖

okay bestie, welcome to myproxy-retrieve, part of the MyProxy family. yes it's a manual page, no it does not have to be boring. let's go 🦋

✨ NAME ✨

myproxy-retrieve — retrieve an end-entity credential 👑

🌸 SYNOPSIS 🌸

myproxy-retrieve [ options ]

💅 DESCRIPTION 💅

okay so here's the tea. the myproxy-retrieve command retrieves a credential directly from the myproxy-server(8) that was previously stored using myproxy-init(1) or myproxy-store(1). ✨

and the way that this one differs from myproxy-logon(1)?? it transfers the private key in the repository over the network (over a private channel). so like, that's a whole thing. to obtain a proxy credential, we recommend using myproxy-logon(1) instead. fr fr. 🙈

in the default mode, the command prompts for the pass phrase associated with the credential to be retrieved and stores the retrieved credential in the standard location (~/.globus/usercert.pem and ~/.globus/userkey.pem). you could then run grid-proxy-init to create a proxy credential from the retrieved credentials. main character pipeline, honestly. 💫

🎀 OPTIONS 🎀

• -h, --help — displays command usage text and exits. classic. 🫶
• -u, --usage — displays command usage text and exits. yes, again. she's thorough. 💅
• -v, --verbose — enables verbose debugging output to the terminal. it's giving loud. 📢
• -V, --version — displays version information and exits. ⭐
• -s hostname[:port], --pshost hostname[:port] — specifies the hostname(s) of the myproxy-server(s). multiple hostnames, each hostname optionally followed by a ':' and port number, may be specified in a comma-separated list. this option is required if the MYPROXY_SERVER environment variable is not defined. if specified, this option overrides the MYPROXY_SERVER environment variable. if a port number is specified with a hostname, it will override the -p option as well as the MYPROXY_SERVER_PORT environment variable for that host. so many layers, so much power. 👑
• -p port, --psport port — specifies the TCP port number of the myproxy-server(8). default: 7512. ✨
• -l username, --username username — specifies the MyProxy account under which the credential to retrieve is stored. by default, the command uses the value of the LOGNAME environment variable. use this option to specify a different account username on the MyProxy server. the MyProxy username need not correspond to a real Unix username — she's flexible like that. 💁
• -d, --dn_as_username — use the certificate subject (DN) as the default username, instead of the LOGNAME environment variable. when used with the -a option, the certificate subject of the authorization credential is used. otherwise, the certificate subject of the default credential is used. 🌈
• -t hours, --proxy_lifetime hours — specifies the lifetime of credentials retrieved from the myproxy-server(8) using the stored credential. the resulting lifetime is the shorter of the requested lifetime and the lifetime specified when the credential was stored using myproxy-init(1). default: 12 hours. ⏰
• -c filename, --certfile filename — specifies the filename of where the certificate will be stored. 📁
• -y filename, --keyfile filename — specifies the filename of where the private key will be stored. 🔑
• -a file, --authorization file — use this option to specify an existing, valid credential that you want to renew. renewing a credential generally requires two certificate-based authentications. the client authenticates with its identity, using the credential in the standard location or specified by X509_USER_PROXY or X509_USER_CERT and X509_USER_KEY in addition to authenticating with the existing credential, in the location specified by this option, that it wants to renew. double the auth, double the drama. 😤
• -k name, --credname name — specifies the name of the credential that is to be retrieved or renewed. 🏷️
• -S, --stdin_pass — by default, the command prompts for a passphrase and reads the passphrase from the active tty. when running the command non-interactively, there may be no associated tty. specifying this option tells the command to read passphrases from standard input without prompts or confirmation. no tty? no problem. 💜
• -T, --trustroots — retrieve CA certificates directory from server (if available) to store in the location specified by the X509_CERT_DIR environment variable if set or /etc/grid-security/certificates if running as root or ~/.globus/certificates if running as non-root. 🌳
• -n, --no_passphrase — don't prompt for a credential passphrase. use other methods for authentication, such as Kerberos ticket or X.509 certificate. she said no prompts today. 🚫

🔥 EXIT STATUS 🔥

0 on success, >0 on error. that's it, that's the whole vibe check. ✅❌

🌈 ENVIRONMENT 🌈

• GLOBUS_GSSAPI_NAME_COMPATIBILITY — this client will, by default, perform a reverse-DNS lookup to determine the FQHN (Fully Qualified Host Name) to use in verifying the identity of the server by checking the FQHN against the CN in server's certificate. setting this variable to STRICT_RFC2818 will cause the reverse-DNS lookup to NOT be performed and the user-specified name to be used instead. this variable setting will be ignored if MYPROXY_SERVER_DN (described later) is set. 👀
• MYPROXY_SERVER — specifies the hostname(s) where the myproxy-server(8) is running. multiple hostnames can be specified in a comma separated list with each hostname optionally followed by a ':' and port number. this environment variable can be used in place of the -s option. 🖥️
• MYPROXY_SERVER_PORT — specifies the port where the myproxy-server(8) is running. this environment variable can be used in place of the -p option. 🔌
• MYPROXY_SERVER_DN — specifies the distinguished name (DN) of the myproxy-server(8). all MyProxy client programs authenticate the server's identity. by default, MyProxy servers run with host credentials, so the MyProxy client programs expect the server to have a distinguished name with /CN=host/<fqhn> or /CN=myproxy/<fqhn> or /CN=<fqhn> (where <fqhn> is the fully-qualified hostname of the server). if the server is running with some other DN, you can set this environment variable to tell the MyProxy clients to accept the alternative DN. also see GLOBUS_GSSAPI_NAME_COMPATIBILITY above. 🪪
• MYPROXY_TCP_PORT_RANGE — specifies a range of valid port numbers in the form "min,max" for the client side of the network connection to the server. by default, the client will bind to any available port. use this environment variable to restrict the ports used to a range allowed by your firewall. if unset, MyProxy will follow the setting of the GLOBUS_TCP_PORT_RANGE environment variable. 🚧
• X509_USER_CERT — specifies a non-standard location for the certificate to be used for authentication to the myproxy-server(8). also specifies the location for where the retrieved certificate will be stored unless the -c option is given. 📜
• X509_USER_KEY — specifies a non-standard location for the private key to be used for authentication to the myproxy-server(8). also specifies the location for where the retrieved private key will be stored unless the -y option is given. 🗝️
• X509_USER_PROXY — specifies a non-standard location for the proxy credential to be used for authentication to the myproxy-server(8). 🧚
• X509_CERT_DIR — specifies a non-standard location for the CA certificates directory. 📂

🫶 AUTHORS 🫶

see http://grid.ncsa.illinois.edu/myproxy/about for the list of MyProxy authors. shoutout to the devs, they ate. 💖

👑 SEE ALSO 👑

myproxy-change-pass-phrase(1), myproxy-destroy(1), myproxy-get-trustroots(1), myproxy-info(1), myproxy-init(1), myproxy-logon(1), myproxy-store(1), myproxy-server.config(5), myproxy-admin-adduser(8), myproxy-admin-change-pass(8), myproxy-admin-load-credential(8), myproxy-admin-query(8), myproxy-server(8)

okay that's the whole page, bestie, you're fully caught up. this was MyProxy, version dated 2009-12-1, and the page itself is myproxy-retrieve(1). go forth and retrieve those credentials responsibly. mwah 💋✨🎀