README.md 1.07 KB
Newer Older
SamwiseFilmore's avatar
SamwiseFilmore committed
1
# redox_users <a href="https://crates.io/crates/redox_users"><img src="https://img.shields.io/crates/v/redox_users.svg"></a>
Jose Narvaez's avatar
Jose Narvaez committed
2

3
Redox OS APIs for accessing users and groups information. [Documentation](https://docs.rs/redox_users/0.1.0/redox_users/)
Jose Narvaez's avatar
Jose Narvaez committed
4

5
High level APIs for:
Jose Narvaez's avatar
Jose Narvaez committed
6
7
8
9
10

- Getting the current process effective user ID.
- Getting the current process user ID.
- Getting the current process effective group ID.
- Getting the current process group ID.
11
- Manipulating User and Group information (including adding, removing, and modifying groups and users, in addition to other functionality, see docs)
Jose Narvaez's avatar
Jose Narvaez committed
12

13
We recommend to use these APIs instead of directly manipulating the
14
`/etc/group` and `/etc/passwd` as this is an implementation detail and
Jose Narvaez's avatar
Jose Narvaez committed
15
16
might change in the future.

17
Note that redox_users is an API designed only for use on Redox. It compiles on other platforms (for testing), but it will not work and might produce unexpected behavior.
18
19
20
21
22
23

## Hashing
redox_users uses the Argon2 hashing algorithm. The default hashing parameters are as follows:
```Rust
Argon2::new(10, 1, 4096, Variant::Argon2i)
```