Skip to content

Commit 270f28e

Browse files
committed
README update
1 parent a162b38 commit 270f28e

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -146,17 +146,29 @@ For the `native` authentication scheme, we can use the currently set iRODS passw
146146

147147
```python
148148
import irods.client_init as iinit
149-
iinit.write_native_credentials_to_secrets_file(irods_password)
149+
iinit.write_native_irodsA_file(irods_password)
150150
```
151151

152-
Note, in the `pam_password` case, this involves sending the cleartext password
153-
to the server (SSL must be enabled!) and then writing the scrambled token that
154-
is returned from the transaction.
155-
156152
If an .irodsA file exists already, it will be overwritten by default; however, if these functions'
157153
overwrite parameter is set to `False`, an exception of type `irods.client_init.irodsA_already_exists`
158154
will be raised to indicate the older .irodsA file is present.
159155

156+
From the command line, we can also run:
157+
```bash
158+
$ prc_write_irodsA.py native <<<"${MY_CURRENT_IRODS_PASSWORD}"
159+
```
160+
161+
The redirect may be left off, in which case the user is prompted for the iRODS password
162+
and echo of the keyboard input will be suppressed. In neither case does the password
163+
become visible on the terminal.
164+
165+
```bash
166+
$ prc_write_irodsA.py native <<<"${MY_CURRENT_IRODS_PASSWORD}"
167+
```
168+
Currently
169+
Note that for the `pam_password` scheme, SSL/TLS must be enabled to avoid sending
170+
an unencrypted password to the server in the clear.
171+
160172
For the `pam_password` authentication scheme, we must first ensure an `irods_environment.json` file exists in the
161173
client environment (necessary for establishing SSL/TLS connection parameters as well as obtaining a PAM token from the server after connecting)
162174
and then make the call to write .irodsA using the Bash commands:

0 commit comments

Comments
 (0)