msign(1)

🎀 NAME 🎀

okay so msign(1) is from the Manta Commands, and it’s literally here to create a signed URL to a Manta object. that’s the whole assignment, bestie. 💅

✨ SYNOPSIS ✨

msign [OPTION...] OBJECT...

🌸 DESCRIPTION 🌸

okay so msign takes a list of objects (or directories), and — using the credentials from the environment (whether environment variables or command line switches) — it creates time-expiring URLs that can be shared with others. this is useful to generate HTML links, for example. no cap. 🔥

The default expiration for URLs is 1 hour from now, but this can be changed with the expires option. the expires option is designed to be used in conjunction with the UNIX date command. in general, you should use the date command with a modifier (the syntax is different between BSD and GNU forms), and format the output to epoch time. iykyk. ⭐

🦋 EXAMPLES 🦋

Assuming the GNU date command, generate a signed URL that expires in one month:

$ msign -e $(date -d "1 month" "+%s") ~~/stor/tmp

On OS X, you would sign this way:

$ msign -e $(date -v+1m "+%s") ~~/stor/tmp

You can also use -E for a friendly relative date format:

$ msign -E 5s ~~/foo # expires in 5 seconds
$ msign -E 5m ~~/foo # expires in 5 minutes
$ msign -E 5h ~~/foo # expires in 5 hours
$ msign -E 5d ~~/foo # expires in 5 days
$ msign -E 5w ~~/foo # expires in 5 weeks
$ msign -E 5y ~~/foo # expires in 5 years

💖 OPTIONS 💖

• -a, --account login — Authenticate as account (login name). 💅
• -e, --expires expiration — Signed URL should last until EXPIRATION (seconds since epoch). Default is 1 hour from now. so you’re passing epoch seconds, not vibes. ⏳
• -E, --expires-relative expiration — Signed URL should last until EXPIRATION (relative time spec). Default is 1 hour from now. Time specification format:

[n]s - seconds from now
[n]m - minutes from now
[n]h - hours from now
[n]d - days from now
[n]w - weeks from now
[n]y - years from now

• -h, --help — Print a help message and exit. slay. 🫶
• -i, --insecure — This option explicitly allows "insecure" SSL connections and transfers. All SSL connections are attempted to be made secure by using the CA certificate bundle installed by default.

bestie, the flag literally says insecure, okay? it’s the explicit opt-in. proceed with that in mind. 🙈

• -k, --key fingerprint — Authenticate using the SSH key described by FINGERPRINT. The key must either be in ~/.ssh or loaded in the SSH agent via ssh-add. 🔑
• -m, --method http_method — Allow URL to work for the HTTP method specified (default is GET). 👑
• --role=ROLE,ROLE,... — Specify which roles to assume for the request. 🎀
• --role-tag=ROLE,ROLE,... — Set the role tags on objects created with the signed URL. 🏷️
• --user user — Authenticate as user under account. 🦋
• -u, --url url — Manta base URL (such as https://us-central.manta.mnx.io). 🌈
• -v, --verbose — Print debug output to stderr. Repeat option to increase verbosity. 🔥

🌈 ENVIRONMENT 🌈

• MANTA_USER — In place of -a, --account.
• MANTA_SUBUSER — In place of --user.
• MANTA_KEY_ID — In place of -k, --key.
• MANTA_ROLE — In place of --role.
• MANTA_URL — In place of -u, --url.
• MANTA_TLS_INSECURE — In place of -i, --insecure.

The shortcut ~~ is equivalent to /:login where :login is the account login name. periodt. 💜

👑 DIAGNOSTICS 👑

When using the -v option, diagnostics will be sent to stderr in bunyan output format. As an example of tracing all information about a request, try:

$ msign -vv ~~/stor/foo 2>&1 | bunyan

💀 BUGS 💀

DSA keys do not work when loaded via the SSH agent. 😭

Report bugs at Github ⟨https://github.com/TritonDataCenter/node-manta/issues⟩

---

and that’s the vibe check, bestie — source/version Manta, dated December 2018, for msign(1). bye 💖🫶