Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Chirp: Add ticket API docs. #3983

Merged
merged 2 commits into from
Nov 19, 2024
Merged

Chirp: Add ticket API docs. #3983

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1e1b79
Reorder ticket functions to correspond to typical usage order.
dthain Nov 18, 2024
c25b0ed
Add API docs for chirp_reli functions which were marked FIXME.
dthain Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions chirp/src/chirp_client.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,14 @@ const char *chirp_client_readdir(struct chirp_client *c, time_t stoptime);
INT64_T chirp_client_getacl(struct chirp_client *c, const char *path, chirp_dir_t callback, void *arg, time_t stoptime);
INT64_T chirp_client_openacl(struct chirp_client *c, const char *path, time_t stoptime);
const char *chirp_client_readacl(struct chirp_client *c, time_t stoptime);

INT64_T chirp_client_ticket_create(struct chirp_client *c, char name[CHIRP_PATH_MAX], unsigned bits, time_t stoptime);
INT64_T chirp_client_ticket_register(struct chirp_client *c, const char *name, const char *subject, time_t duration, time_t stoptime);
INT64_T chirp_client_ticket_delete(struct chirp_client *c, const char *name, time_t stoptime);
INT64_T chirp_client_ticket_list(struct chirp_client *c, const char *subject, char ***list, time_t stoptime);
INT64_T chirp_client_ticket_get(struct chirp_client *c, const char *name, char **subject, char **ticket, time_t * duration, char ***rights, time_t stoptime);
INT64_T chirp_client_ticket_modify(struct chirp_client *c, const char *name, const char *path, const char *aclmask, time_t stoptime);
INT64_T chirp_client_ticket_get(struct chirp_client *c, const char *name, char **subject, char **ticket, time_t * duration, char ***rights, time_t stoptime);
INT64_T chirp_client_ticket_list(struct chirp_client *c, const char *subject, char ***list, time_t stoptime);
INT64_T chirp_client_ticket_delete(struct chirp_client *c, const char *name, time_t stoptime);

INT64_T chirp_client_setacl(struct chirp_client *c, const char *path, const char *user, const char *acl, time_t stoptime);
INT64_T chirp_client_resetacl(struct chirp_client *c, const char *path, const char *acl, time_t stoptime);
INT64_T chirp_client_locate(struct chirp_client *c, const char *path, chirp_loc_t callback, void *arg, time_t stoptime);
Expand Down
64 changes: 60 additions & 4 deletions chirp/src/chirp_reli.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,14 +337,70 @@ Note that this function has no timeoutbecause it operates solely on memory struc

void chirp_reli_closedir(struct chirp_dir *dir);

/* FIXME document */
/** Create a new blank access control ticket.
@param host The name and port of the Chirp server to access.
@param name An empty array that will be filled with a unique ticket filename.
@param bits The cryptographic length of the ticket, in bits. (typically 1024)
@param stoptime The absolute time at which to abort.
@return On success, returns greater than or equal to zero. On failure, returns less than zero and sets errno.
*/

INT64_T chirp_reli_ticket_create(const char *host, char name[CHIRP_PATH_MAX], unsigned bits, time_t stoptime);

/** Register an access control ticket with a file serer.
@param host The name and port of the Chirp server to access.
@param name The name of an existing ticket.
@param subject The subject to be granted access with this ticket, which should be "self" for normal users.
@param duration The lifetime of this ticket, in seconds.
@param stoptime The absolute time at which to abort.
@return On success, returns greater than or equal to zero. On failure, returns less than zero and sets errno.
*/

INT64_T chirp_reli_ticket_register(const char *host, const char *name, const char *subject, time_t duration, time_t stoptime);
INT64_T chirp_reli_ticket_delete(const char *host, const char *name, time_t stoptime);
INT64_T chirp_reli_ticket_list(const char *host, const char *subject, char ***list, time_t stoptime);
INT64_T chirp_reli_ticket_get(const char *host, const char *name, char **subject, char **ticket, time_t * duration, char ***rights, time_t stoptime);

/** Modify an access control ticket to grant futher access.
@param host The name and port of the Chirp server to access.
@param name The name of an existing ticket.
@param path The filesystem path that will be added to the ticket.
@param aclmask The access rights that will be added to the ticket, any of "rwldax".
@param stoptime The absolute time at which to abort.
@return On success, returns greater than or equal to zero. On failure, returns less than zero and sets errno.
*/

INT64_T chirp_reli_ticket_modify(const char *host, const char *name, const char *path, const char *aclmask, time_t stoptime);

/** Get the details of a registered ticket.
@param host The name and port of the Chirp server to access.
@param name The name of an existing ticket.
@param subject A pointer to a string that will be allocated with the name of the ticket owner.
@param ticket A pointer to a string that will be allocated with the name of the ticket. (XXX)
@param duration A pointer to an integer that will be filled with the duration of the ticket.
@param rights A pointer to a list of strings that will be filled with ticket rights.
@param stoptime The absolute time at which to abort.
@return On success, returns greater than or equal to zero. On failure, returns less than zero and sets errno.
*/

INT64_T chirp_reli_ticket_get(const char *host, const char *name, char **subject, char **ticket, time_t * duration, char ***rights, time_t stoptime);

/** List registered tikets on a server.
@param host The name and port of the Chirp server to access.
@param subject The user whose tickets to list, typically "self" for a normal user.
@param list A pointer to an (unallocated) list of strings which will be filled in with registered tickets.
@param stoptime The absolute time at which to abort.
@return On success, returns greater than or equal to zero. On failure, returns less than zero and sets errno.
*/

INT64_T chirp_reli_ticket_list(const char *host, const char *subject, char ***list, time_t stoptime);

/** Delete an access control ticket.
@param host The name and port of the Chirp server to access.
@param name The name of an existing ticket file on the local filesystem.
@param stoptime The absolute time at which to abort.
@return On success, returns greater than or equal to zero. On failure, returns less than zero and sets errno.
*/

INT64_T chirp_reli_ticket_delete(const char *host, const char *name, time_t stoptime);

/** Get an access control list.
@param host The name and port of the Chirp server to access.
@param path The pathname of the directory to access.
Expand Down
Loading