LUDOC-297 protocol: Update protocol document

[doc/protocol.git] / struct_lustre_capa.txt

diff --git a/struct_lustre_capa.txt b/struct_lustre_capa.txt
new file mode 100644 (file)
index 0000000..2e2f061
--- /dev/null
+++ b/struct_lustre_capa.txt
@@ -0,0 +1,20 @@
+.Lustre Capability
+[[struct-lustre-capa]]
+****
+The so-called "capabilities" structure is deprecated in recent
+versions of Lustre, and commonly appears in the packet header as a zero
+length buffer. It conveys security capabilities. See <<security>>.
+----
+struct lustre_capa {
+        struct lu_fid   lc_fid;         /** fid */
+        __u64           lc_opc;         /** operations allowed */
+        __u64           lc_uid;         /** file owner */
+        __u64           lc_gid;         /** file group */
+        __u32           lc_flags;       /** HMAC algorithm & flags */
+        __u32           lc_keyid;       /** key# used for the capability */
+        __u32           lc_timeout;     /** capa timeout value (sec) */
+        __u32           lc_expiry;      /** expiry time (sec) */
+        __u8            lc_hmac[CAPA_HMAC_MAX_LEN];   /** HMAC */
+};
+----
+****