Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/share/man/man3/keyctl_update.3 @ 68:5028fdace37b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 16:23:26 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 68:5028fdace37b
1 .\"
2 .\" Copyright (C) 2006 Red Hat, Inc. All Rights Reserved.
3 .\" Written by David Howells (dhowells@redhat.com)
4 .\"
5 .\" This program is free software; you can redistribute it and/or
6 .\" modify it under the terms of the GNU General Public License
7 .\" as published by the Free Software Foundation; either version
8 .\" 2 of the License, or (at your option) any later version.
9 .\"
10 .TH KEYCTL_UPDATE 3 "4 May 2006" Linux "Linux Key Management Calls"
11 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
12 .SH NAME
13 keyctl_update \- update a key
14 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
15 .SH SYNOPSIS
16 .nf
17 .B #include <keyutils.h>
18 .sp
19 .BI "long keyctl_update(key_serial_t " key ", const void *" payload ,
20 .BI "size_t " plen ");"
21 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
22 .SH DESCRIPTION
23 .BR keyctl_update ()
24 updates the payload of a key if the key type permits it.
25 .P
26 The caller must have
27 .B write
28 permission on a key to be able update it.
29 .P
30 .I payload
31 and
32 .I plen
33 specify the data for the new payload.
34 .I payload
35 may be NULL and
36 .I plen
37 may be zero if the key type permits that. The key type may reject the data if
38 it's in the wrong format or in some other way invalid.
39 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
40 .SH RETURN VALUE
41 On success
42 .BR keyctl_update ()
43 returns
44 .BR 0 .
45 On error, the value
46 .B -1
47 will be returned and
48 .I errno
49 will have been set to an appropriate error.
50 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
51 .SH ERRORS
52 .TP
53 .B ENOKEY
54 The key specified is invalid.
55 .TP
56 .B EKEYEXPIRED
57 The key specified has expired.
58 .TP
59 .B EKEYREVOKED
60 The key specified had been revoked.
61 .TP
62 .B EINVAL
63 The payload data was invalid.
64 .TP
65 .B ENOMEM
66 Insufficient memory to store the new payload.
67 .TP
68 .B EDQUOT
69 The key quota for this user would be exceeded by increasing the size of the
70 key to accommodate the new payload.
71 .TP
72 .B EACCES
73 The key exists, but is not
74 .B writable
75 by the calling process.
76 .TP
77 .B EOPNOTSUPP
78 The key type does not support the update operation on its keys.
79 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
80 .SH LINKING
81 This is a library function that can be found in
82 .IR libkeyutils .
83 When linking,
84 .B \-lkeyutils
85 should be specified to the linker.
86 .\"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
87 .SH SEE ALSO
88 .ad l
89 .nh
90 .BR keyctl (1),
91 .BR add_key (2),
92 .BR keyctl (2),
93 .BR request_key (2),
94 .BR keyctl (3),
95 .BR keyrings (7),
96 .BR keyutils (7)