Skip to content

Commit e268702

Browse files
committed
README documentation
1 parent 9d47c5d commit e268702

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,24 @@ the `encryption_*` and `ssl_*` options
162162
directly to the constructor as keyword arguments, even though it is
163163
required when they are placed in the environment file.
164164

165+
Creating PAM or Native Credentials File (.irodsA)
166+
-------------------------------------------------
167+
168+
Two free functions exist for creating encoded authentication files:
169+
```
170+
irods.client_init.write_native_credentials_to_secrets_file
171+
irods.client_init.write_pam_credentials_to_secrets_file
172+
```
173+
174+
Each takes a cleartext password and writes an appropriately processed version of it
175+
into an .irodsA (secrets) file in the login environment.
176+
177+
Note, in the `pam_password` case, this involves sending the cleartext password
178+
to the server (SSL should thus be enabled!) and then writing the scrambled token that
179+
returns from the transaction.
180+
181+
If an .irodsA file exists already, it will be overwritten.
182+
165183
PAM logins
166184
----------
167185

@@ -171,8 +189,7 @@ iCommands.
171189
Caveat for iRODS 4.3+: when upgrading from 4.2, the "irods_authentication_scheme" setting must be changed from "pam" to "pam_password" in
172190
`~/.irods/irods_environment.json` for all file-based client environments.
173191

174-
To replicate iinit's capability for creating valid PAM login credentials file (.irodsA) for the client login environment, we can set these
175-
two configuration variables:
192+
To use the PRC PAM login credentials update function for the client login environment, we can set these two configuration variables:
176193

177194
```
178195
legacy_auth.pam.password_for_auto_renew "my_pam_password"

0 commit comments

Comments
 (0)