diff options
Diffstat (limited to '')
| -rw-r--r-- | src/civetweb/docs/api/mg_modify_passwords_file.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/src/civetweb/docs/api/mg_modify_passwords_file.md b/src/civetweb/docs/api/mg_modify_passwords_file.md new file mode 100644 index 000000000..edb5f0214 --- /dev/null +++ b/src/civetweb/docs/api/mg_modify_passwords_file.md @@ -0,0 +1,33 @@ +# Civetweb API Reference + +### `mg_modify_passwords_file( passwords_file_name, domain, user, password );` + +### Parameters + +| Parameter | Type | Description | +| :--- | :--- | :--- | +|**`passwords_file_name`**|`const char *`|The path to the passwords file| +|**`realm`**|`const char *`|The authentication realm (domain) of the user record| +|**`user`**|`const char *`|Username of the record to be added, changed or deleted| +|**`password`**|`const char *`|Password associated with the user or NULL if the record must be deleted| + +### Return Value + +| Type | Description | +| :--- | :--- | +|`int`|Success or error code| + +### Description + +The function `mg_modify_passwords_file()` allows an application to manipulate .htpasswd files on the fly by adding, deleting and changing user records. This is one of the several ways to implement authentication on the server side. + +If the password parameter is not `NULL` an entry is added to the password file. An existing records is modified in that case. If `NULL` is used as the password the enrty is removed from the file. + +The function returns 1 when successful and 0 if an error occurs. + +### See Also + +* [`mg_check_digest_access_authentication();`](mg_check_digest_access_authentication.md) +* [`mg_send_digest_access_authentication_request();`](mg_send_digest_access_authentication_request.md) + + |