1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * Upcall description for nfsdcld communication 4*4882a593Smuzhiyun * 5*4882a593Smuzhiyun * Copyright (c) 2012 Red Hat, Inc. 6*4882a593Smuzhiyun * Author(s): Jeff Layton <jlayton@redhat.com> 7*4882a593Smuzhiyun * 8*4882a593Smuzhiyun * This program is free software; you can redistribute it and/or modify 9*4882a593Smuzhiyun * it under the terms of the GNU General Public License as published by 10*4882a593Smuzhiyun * the Free Software Foundation; either version 2 of the License, or 11*4882a593Smuzhiyun * (at your option) any later version. 12*4882a593Smuzhiyun * 13*4882a593Smuzhiyun * This program is distributed in the hope that it will be useful, 14*4882a593Smuzhiyun * but WITHOUT ANY WARRANTY; without even the implied warranty of 15*4882a593Smuzhiyun * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16*4882a593Smuzhiyun * GNU General Public License for more details. 17*4882a593Smuzhiyun * 18*4882a593Smuzhiyun * You should have received a copy of the GNU General Public License 19*4882a593Smuzhiyun * along with this program; if not, write to the Free Software 20*4882a593Smuzhiyun * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 21*4882a593Smuzhiyun */ 22*4882a593Smuzhiyun 23*4882a593Smuzhiyun #ifndef _NFSD_CLD_H 24*4882a593Smuzhiyun #define _NFSD_CLD_H 25*4882a593Smuzhiyun 26*4882a593Smuzhiyun #include <linux/types.h> 27*4882a593Smuzhiyun 28*4882a593Smuzhiyun /* latest upcall version available */ 29*4882a593Smuzhiyun #define CLD_UPCALL_VERSION 2 30*4882a593Smuzhiyun 31*4882a593Smuzhiyun /* defined by RFC3530 */ 32*4882a593Smuzhiyun #define NFS4_OPAQUE_LIMIT 1024 33*4882a593Smuzhiyun 34*4882a593Smuzhiyun #ifndef SHA256_DIGEST_SIZE 35*4882a593Smuzhiyun #define SHA256_DIGEST_SIZE 32 36*4882a593Smuzhiyun #endif 37*4882a593Smuzhiyun 38*4882a593Smuzhiyun enum cld_command { 39*4882a593Smuzhiyun Cld_Create, /* create a record for this cm_id */ 40*4882a593Smuzhiyun Cld_Remove, /* remove record of this cm_id */ 41*4882a593Smuzhiyun Cld_Check, /* is this cm_id allowed? */ 42*4882a593Smuzhiyun Cld_GraceDone, /* grace period is complete */ 43*4882a593Smuzhiyun Cld_GraceStart, /* grace start (upload client records) */ 44*4882a593Smuzhiyun Cld_GetVersion, /* query max supported upcall version */ 45*4882a593Smuzhiyun }; 46*4882a593Smuzhiyun 47*4882a593Smuzhiyun /* representation of long-form NFSv4 client ID */ 48*4882a593Smuzhiyun struct cld_name { 49*4882a593Smuzhiyun __u16 cn_len; /* length of cm_id */ 50*4882a593Smuzhiyun unsigned char cn_id[NFS4_OPAQUE_LIMIT]; /* client-provided */ 51*4882a593Smuzhiyun } __attribute__((packed)); 52*4882a593Smuzhiyun 53*4882a593Smuzhiyun /* sha256 hash of the kerberos principal */ 54*4882a593Smuzhiyun struct cld_princhash { 55*4882a593Smuzhiyun __u8 cp_len; /* length of cp_data */ 56*4882a593Smuzhiyun unsigned char cp_data[SHA256_DIGEST_SIZE]; /* hash of principal */ 57*4882a593Smuzhiyun } __attribute__((packed)); 58*4882a593Smuzhiyun 59*4882a593Smuzhiyun struct cld_clntinfo { 60*4882a593Smuzhiyun struct cld_name cc_name; 61*4882a593Smuzhiyun struct cld_princhash cc_princhash; 62*4882a593Smuzhiyun } __attribute__((packed)); 63*4882a593Smuzhiyun 64*4882a593Smuzhiyun /* message struct for communication with userspace */ 65*4882a593Smuzhiyun struct cld_msg { 66*4882a593Smuzhiyun __u8 cm_vers; /* upcall version */ 67*4882a593Smuzhiyun __u8 cm_cmd; /* upcall command */ 68*4882a593Smuzhiyun __s16 cm_status; /* return code */ 69*4882a593Smuzhiyun __u32 cm_xid; /* transaction id */ 70*4882a593Smuzhiyun union { 71*4882a593Smuzhiyun __s64 cm_gracetime; /* grace period start time */ 72*4882a593Smuzhiyun struct cld_name cm_name; 73*4882a593Smuzhiyun __u8 cm_version; /* for getting max version */ 74*4882a593Smuzhiyun } __attribute__((packed)) cm_u; 75*4882a593Smuzhiyun } __attribute__((packed)); 76*4882a593Smuzhiyun 77*4882a593Smuzhiyun /* version 2 message can include hash of kerberos principal */ 78*4882a593Smuzhiyun struct cld_msg_v2 { 79*4882a593Smuzhiyun __u8 cm_vers; /* upcall version */ 80*4882a593Smuzhiyun __u8 cm_cmd; /* upcall command */ 81*4882a593Smuzhiyun __s16 cm_status; /* return code */ 82*4882a593Smuzhiyun __u32 cm_xid; /* transaction id */ 83*4882a593Smuzhiyun union { 84*4882a593Smuzhiyun struct cld_name cm_name; 85*4882a593Smuzhiyun __u8 cm_version; /* for getting max version */ 86*4882a593Smuzhiyun struct cld_clntinfo cm_clntinfo; /* name & princ hash */ 87*4882a593Smuzhiyun } __attribute__((packed)) cm_u; 88*4882a593Smuzhiyun } __attribute__((packed)); 89*4882a593Smuzhiyun 90*4882a593Smuzhiyun struct cld_msg_hdr { 91*4882a593Smuzhiyun __u8 cm_vers; /* upcall version */ 92*4882a593Smuzhiyun __u8 cm_cmd; /* upcall command */ 93*4882a593Smuzhiyun __s16 cm_status; /* return code */ 94*4882a593Smuzhiyun __u32 cm_xid; /* transaction id */ 95*4882a593Smuzhiyun } __attribute__((packed)); 96*4882a593Smuzhiyun 97*4882a593Smuzhiyun #endif /* !_NFSD_CLD_H */ 98