rclone/docs/content/commands/rclone_obscure.md

54 lines
1.6 KiB
Markdown
Raw Normal View History

2017-03-05 11:19:22 +01:00
---
title: "rclone obscure"
2021-02-02 14:42:35 +01:00
description: "Obscure password for use in the rclone config file."
2022-12-20 18:16:14 +01:00
versionIntroduced: v1.36
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/obscure/ and as part of making a release run "make commanddocs"
2017-03-05 11:19:22 +01:00
---
# rclone obscure
2017-03-05 11:19:22 +01:00
2021-02-02 14:42:35 +01:00
Obscure password for use in the rclone config file.
2017-03-05 11:19:22 +01:00
## Synopsis
2017-03-05 11:19:22 +01:00
2022-03-18 13:29:54 +01:00
In the rclone config file, human-readable passwords are
2020-09-02 17:59:04 +02:00
obscured. Obscuring them is done by encrypting them and writing them
out in base64. This is **not** a secure way of encrypting these
passwords as rclone can decrypt them - it is to prevent "eyedropping"
- namely someone seeing a password in the rclone config file by
accident.
Many equally important things (like access tokens) are not obscured in
the config file. However it is very hard to shoulder surf a 64
character hex token.
This command can also accept a password through STDIN instead of an
2021-02-02 14:42:35 +01:00
argument by passing a hyphen as an argument. This will use the first
line of STDIN as the password not including the trailing newline.
2020-09-02 17:59:04 +02:00
2022-07-09 19:08:20 +02:00
echo "secretpassword" | rclone obscure -
2020-09-02 17:59:04 +02:00
If there is no data on STDIN to read, rclone obscure will default to
obfuscating the hyphen itself.
If you want to encrypt the config file then please use config file
encryption - see [rclone config](/commands/rclone_config/) for more
info.
2017-03-05 11:19:22 +01:00
```
2017-09-30 15:19:47 +02:00
rclone obscure password [flags]
```
## Options
2017-09-30 15:19:47 +02:00
```
-h, --help help for obscure
2017-03-05 11:19:22 +01:00
```
2023-08-02 11:02:38 +02:00
See the [global flags page](/flags/) for global options not listed here.
2023-08-02 11:02:38 +02:00
# SEE ALSO
2017-03-05 11:19:22 +01:00
2018-10-15 12:03:08 +02:00
* [rclone](/commands/rclone/) - Show help for rclone commands, flags and backends.
2018-03-19 11:06:13 +01:00