s390/zcrypt: fix reply buffer calculations for CCA replies
Subsystems (3)
Harald Freudenberger
maintainerPATCH v2 1/1 s390/zcrypt: fix reply buffer calculations for CCA replies
The length information for available buffer space for CCA replies is covered with two fields in the T6 header prepended on each CCA reply: fromcardlen1 and fromcardlen2. The sum of these both values must not exceed the AP bus limit for this card (24KB for CEX8, 12KB CEX7 and older) minus the always present headers.
The current code adjusted the fromcardlen2 value in case of exceeding the AP bus limit when there was a non-zero value given from userspace. Some tests now showed that this was the wrong assumption. Instead the userspace value given for this field should always be trusted and if the sum of the wo fields exceeds the AP bus limit for this card the first field fromcardlen1 should be adjusted instead.
So now the calculation is done with this new insight in mind. Also some additional checks for overflow have been introduced and some comments to provide some documentation for future maintainers of this complicated calculation code.
Furthermore the 128 bytes of fix overhead which is used in the current code is not correct. Investications showed that for a reply always the same two header structs are prepended before a possible payload. So this is also fixed with this patch.
--- drivers/s390/crypto/zcrypt_msgtype6.c | 45 ++++++++++++++++++++------- 1 file changed, 33 insertions(+), 12 deletions(-)
drivers/s390/crypto/zcrypt_msgtype6.c +33 -12
@@ -551,6 +551,12 @@ static int xcrb_msg_to_type6_ep11cprb_msgx(bool userspace, struct ap_message *ap* * Returns 0 on success or -EINVAL, -EFAULT, -EAGAIN in case of an error. */ +struct type86_reply_hdrs { +struct type86_hdr hdr; +struct type86_fmt2_ext fmt2; +/* ... payload may follow ... */ +} __packed; +struct type86x_reply {struct type86_hdr hdr;struct type86_fmt2_ext fmt2;
@@ -1101,23 +1107,38 @@ static long zcrypt_msgtype6_send_cprb(bool userspace, struct zcrypt_queue *zq,struct ica_xcRB *xcrb, struct ap_message *ap_msg) { - int rc; + unsigned int reply_bufsize_minus_headers = + zq->reply.bufsize -sizeof (struct type86_reply_hdrs );struct response_type *rtype = ap_msg->private;struct {struct type6_hdr hdr;struct CPRBX cprbx;/* ... more data blocks ... */ } __packed * msg = ap_msg->msg; - -/* -* Set the queue's reply buffer length minus 128 byte padding -* as reply limit for the card firmware. -*/ - msg->hdr.fromcardlen1 = min_t(unsigned int, msg->hdr.fromcardlen1, - zq->reply.bufsize -128 ); -if (msg->hdr.fromcardlen2) - msg->hdr.fromcardlen2 = - zq->reply.bufsize - msg->hdr.fromcardlen1 -128 ; +int rc, delta; + +/* limit each of the two from fields to AP bus limit - headers */ + msg->hdr.fromcardlen1 = min_t(unsigned int, + msg->hdr.fromcardlen1, + reply_bufsize_minus_headers); + msg->hdr.fromcardlen2 = min_t(unsigned int, + msg->hdr.fromcardlen2, + reply_bufsize_minus_headers); + +/* calculate delta if the sum of both exceeds AP bus limit - headers */ + delta = msg->hdr.fromcardlen1 + msg->hdr.fromcardlen2 + - reply_bufsize_minus_headers; +if (delta >0 ) { +/* +* Sum exceeds AP bus limit - headers, prune fromcardlen1 +* (always trust fromcardlen2) +*/ +if (delta > msg->hdr.fromcardlen1) { + rc = -EINVAL ; + goto out; + } + msg->hdr.fromcardlen1 -= delta; + }init_completion (&rtype->work); rc =ap_queue_message (zq->queue, ap_msg);
@@ -1240,7 +1261,7 @@ static long zcrypt_msgtype6_send_ep11_cprb(bool userspace, struct zcrypt_queue ** as reply limit for the card firmware. */ msg->hdr.fromcardlen1 = zq->reply.bufsize - -sizeof (struct type86_hdr ) -sizeof (struct type86_fmt2_ext ); +sizeof (struct type86_reply_hdrs );init_completion (&rtype->work); rc =ap_queue_message (zq->queue, ap_msg);
Signature · 1 line
2.34.1
Quoted 7 lines · Harald Freudenberger
The length information for available buffer space for CCA replies is covered with two fields in the T6 header prepended on each CCA reply: fromcardlen1 and fromcardlen2. The sum of these both values must not exceed the AP bus limit for this card (24KB for CEX8, 12KB CEX7 and older) minus the always present headers.
Quoted 6 lines
The current code adjusted the fromcardlen2 value in case of exceeding the AP bus limit when there was a non-zero value given from userspace. Some tests now showed that this was the wrong assumption. Instead the userspace value given for this field should always be trusted and if the sum of the wo fields exceeds the AP bus limit for this card the first
typo: two
Quoted 9 lines
field fromcardlen1 should be adjusted instead.
So now the calculation is done with this new insight in mind. Also some additional checks for overflow have been introduced and some comments to provide some documentation for future maintainers of this complicated calculation code.
Furthermore the 128 bytes of fix overhead which is used in the current code is not correct. Investications showed
typo: Investigations
Quoted 6 lines
that for a reply always the same two header structs are prepended before a possible payload. So this is also fixed with this patch.
Signed-off-by Harald Freudenberger <[email protected]>
With the typos fixed and the changes below
Quoted 9 lines
--- drivers/s390/crypto/zcrypt_msgtype6.c | 45 ++++++++++++++++++++------- 1 file changed, 33 insertions(+), 12 deletions(-)drivers/s390/crypto/zcrypt_msgtype6.c +0
-0
drivers/s390/crypto/zcrypt_msgtype6.c static int xcrb_msg_to_type6_ep11cprb_msgx(bool userspace, struct ap_message *ap · line 559
Quoted 9 lines
drivers/s390/crypto/zcrypt_msgtype6.c +6
-0@@ -551,6 +551,12 @@ static int xcrb_msg_to_type6_ep11cprb_msgx(bool userspace, struct ap_message *ap* * Returns 0 on success or -EINVAL, -EFAULT, -EAGAIN in case of an error. */ +struct type86_reply_hdrs { +struct type86_hdr hdr; +struct type86_fmt2_ext fmt2; +/* ... payload may follow ... */ +} __packed; +
There is already a struct type86_fmt2_msg in this file (line 329 ff.).
drivers/s390/crypto/zcrypt_msgtype6.c static long zcrypt_msgtype6_send_cprb(bool userspace, struct zcrypt_queue *zq, · line 1111
Quoted 10 lines
drivers/s390/crypto/zcrypt_msgtype6.c +2
-1struct type86x_reply {struct type86_hdr hdr;struct type86_fmt2_ext fmt2;@@ -1101,23 +1107,38 @@ static long zcrypt_msgtype6_send_cprb(bool userspace, struct zcrypt_queue *zq,struct ica_xcRB *xcrb, struct ap_message *ap_msg) { - int rc; + unsigned int reply_bufsize_minus_headers = + zq->reply.bufsize -sizeof (struct type86_reply_hdrs );
I don't like this variable name. What about max_payload_size?
Quoted 9 lines
drivers/s390/crypto/zcrypt_msgtype6.c +0
-3struct response_type *rtype = ap_msg->private;struct {struct type6_hdr hdr;struct CPRBX cprbx;/* ... more data blocks ... */ } __packed * msg = ap_msg->msg; - -/* -* Set the queue's reply buffer length minus 128 byte padding
drivers/s390/crypto/zcrypt_msgtype6.c static long zcrypt_msgtype6_send_cprb(bool userspace, struct zcrypt_queue *zq, · line 1120
Quoted 10 lines
drivers/s390/crypto/zcrypt_msgtype6.c +3
-7-* as reply limit for the card firmware. -*/ - msg->hdr.fromcardlen1 = min_t(unsigned int, msg->hdr.fromcardlen1, - zq->reply.bufsize -128 ); -if (msg->hdr.fromcardlen2) - msg->hdr.fromcardlen2 = - zq->reply.bufsize - msg->hdr.fromcardlen1 -128 ; +int rc, delta; + +/* limit each of the two from fields to AP bus limit - headers */
I would also use "maximal payload size" here.
/* limit each of the two from fields to the maximum payload size */
drivers/s390/crypto/zcrypt_msgtype6.c static long zcrypt_msgtype6_send_cprb(bool userspace, struct zcrypt_queue *zq, · line 1128
Quoted 8 lines
drivers/s390/crypto/zcrypt_msgtype6.c +8
-0+ msg->hdr.fromcardlen1 = min_t(unsigned int, + msg->hdr.fromcardlen1, + reply_bufsize_minus_headers); + msg->hdr.fromcardlen2 = min_t(unsigned int, + msg->hdr.fromcardlen2, + reply_bufsize_minus_headers); + +/* calculate delta if the sum of both exceeds AP bus limit - headers */
dito:
/* calculate delta if the sum of both exceeds the maximum payload size */
drivers/s390/crypto/zcrypt_msgtype6.c static long zcrypt_msgtype6_send_cprb(bool userspace, struct zcrypt_queue *zq, · line 1133
Quoted 5 lines
drivers/s390/crypto/zcrypt_msgtype6.c +5
-0+ delta = msg->hdr.fromcardlen1 + msg->hdr.fromcardlen2 + - reply_bufsize_minus_headers; +if (delta >0 ) { +/* +* Sum exceeds AP bus limit - headers, prune fromcardlen1
dito:
* Sum exceeds the maximum payload size, prune fromcardlen1
Quoted 20 lines
drivers/s390/crypto/zcrypt_msgtype6.c +9
-1+* (always trust fromcardlen2) +*/ +if (delta > msg->hdr.fromcardlen1) { + rc = -EINVAL ; + goto out; + } + msg->hdr.fromcardlen1 -= delta; + }init_completion (&rtype->work); rc =ap_queue_message (zq->queue, ap_msg);@@ -1240,7 +1261,7 @@ static long zcrypt_msgtype6_send_ep11_cprb(bool userspace, struct zcrypt_queue ** as reply limit for the card firmware. */ msg->hdr.fromcardlen1 = zq->reply.bufsize - -sizeof (struct type86_hdr ) -sizeof (struct type86_fmt2_ext ); +sizeof (struct type86_reply_hdrs );init_completion (&rtype->work); rc =ap_queue_message (zq->queue, ap_msg);
Signature · 5 lines
Mit freundlichen Grüßen / Kind regards Holger Dengler -- IBM Systems, Linux on IBM Z Development [email protected]
Harald Freudenberger
maintainerQuoted 8 lines · Holger Dengler
Quoted 7 lines · Harald Freudenberger
The length information for available buffer space for CCA replies is covered with two fields in the T6 header prepended on each CCA reply: fromcardlen1 and fromcardlen2. The sum of these both values must not exceed the AP bus limit for this card (24KB for CEX8, 12KB CEX7 and older) minus the always present headers.
Quoted 8 lines
Quoted 6 lines
The current code adjusted the fromcardlen2 value in case of exceeding the AP bus limit when there was a non-zero value given from userspace. Some tests now showed that this was the wrong assumption. Instead the userspace value given for this field should always be trusted and if the sum of the wo fields exceeds the AP bus limit for this card the first
typo: two
fixed
Quoted 8 lines
Quoted 8 lines
field fromcardlen1 should be adjusted instead.
So now the calculation is done with this new insight in mind. Also some additional checks for overflow have been introduced and some comments to provide some documentation for future maintainers of this complicated calculation code.
Quoted 4 lines
Quoted 2 lines
Furthermore the 128 bytes of fix overhead which is used in the current code is not correct. Investications showed
typo: Investigations
fixed ... did I forget to run the spell checker ??? ...
Quoted 26 lines
Quoted 7 lines
that for a reply always the same two header structs are prepended before a possible payload. So this is also fixed with this patch.
Signed-off-by Harald Freudenberger <[email protected]>With the typos fixed and the changes below
Reviewed-by Holger Dengler <[email protected]>Quoted 15 lines
--- drivers/s390/crypto/zcrypt_msgtype6.c | 45 ++++++++++++++++++++------- 1 file changed, 33 insertions(+), 12 deletions(-)drivers/s390/crypto/zcrypt_msgtype6.c +0
-0@@ -551,6 +551,12 @@ static int xcrb_msg_to_type6_ep11cprb_msgx(booluserspace, struct
ap_message*ap
*
* Returns 0 on success or-EINVAL,-EFAULT,-EAGAINin case of an
error.
*/
Quoted 8 lines
drivers/s390/crypto/zcrypt_msgtype6.c static int xcrb_msg_to_type6_ep11cprb_msgx(bool userspace, struct ap_message *ap · line 559
Quoted 6 lines
drivers/s390/crypto/zcrypt_msgtype6.c +6
-0+struct type86_reply_hdrs { +struct type86_hdr hdr; +struct type86_fmt2_ext fmt2; +/* ... payload may follow ... */ +} __packed; +There is already a
struct type86_fmt2_msgin this file (line 329 ff.).
Yes, I saw that. This will be consolidated with a cleanup patch series I am about to develop just now.
Quoted 29 lines
drivers/s390/crypto/zcrypt_msgtype6.c static long zcrypt_msgtype6_send_cprb(bool · line 1112
Quoted 12 lines
struct
type86x_reply{drivers/s390/crypto/zcrypt_msgtype6.c +2
-1struct type86_hdr hdr;struct type86_fmt2_ext fmt2;@@ -1101,23 +1107,38 @@ static long zcrypt_msgtype6_send_cprb(bool userspace, struct zcrypt_queue *zq, struct ica_xcRB *xcrb, struct ap_message *ap_msg) { -int rc; +unsigned int reply_bufsize_minus_headers = + zq->reply.bufsize -sizeof (struct type86_reply_hdrs );I don't like this variable name. What about
max_payload_size?Quoted 14 lines
drivers/s390/crypto/zcrypt_msgtype6.c +0
-8struct response_type *rtype = ap_msg->private;struct {struct type6_hdr hdr;struct CPRBX cprbx;/* ... more data blocks ... */ } __packed * msg = ap_msg->msg; - -/* -* Set the queue's reply buffer length minus 128 byte padding -* as reply limit for the card firmware. -*/ - msg->hdr.fromcardlen1 = min_t(unsigned int, msg->hdr.fromcardlen1, - zq->reply.bufsize -128 ); -if (msg->hdr.fromcardlen2)
Quoted 8 lines
drivers/s390/crypto/zcrypt_msgtype6.c static long zcrypt_msgtype6_send_cprb(bool userspace, struct zcrypt_queue *zq, · line 1120
Quoted 5 lines
drivers/s390/crypto/zcrypt_msgtype6.c +3
-2- msg->hdr.fromcardlen2 = - zq->reply.bufsize - msg->hdr.fromcardlen1 -128 ; +int rc, delta; + +/* limit each of the two from fields to AP bus limit - headers */ I would also use "maximal payload size" here.
/* limit each of the two from fields to the maximum payload size */
will do
Quoted 14 lines
drivers/s390/crypto/zcrypt_msgtype6.c static long zcrypt_msgtype6_send_cprb(bool userspace, struct zcrypt_queue *zq,
Quoted 10 lines
drivers/s390/crypto/zcrypt_msgtype6.c +8
-0+ msg->hdr.fromcardlen1 = min_t(unsigned int, + msg->hdr.fromcardlen1, + reply_bufsize_minus_headers); + msg->hdr.fromcardlen2 = min_t(unsigned int, + msg->hdr.fromcardlen2, + reply_bufsize_minus_headers); + +/* calculate delta if the sum of both exceeds AP bus limit - headers */ dito:
/* calculate delta if the sum of both exceeds the maximum payload size */
jaaaa...
Quoted 9 lines
drivers/s390/crypto/zcrypt_msgtype6.c static long zcrypt_msgtype6_send_cprb(bool userspace, struct zcrypt_queue *zq, · line 1133
Quoted 5 lines
drivers/s390/crypto/zcrypt_msgtype6.c +5
-0+ delta = msg->hdr.fromcardlen1 + msg->hdr.fromcardlen2 + - reply_bufsize_minus_headers; +if (delta >0 ) { +/* +* Sum exceeds AP bus limit - headers, prune fromcardlen1 dito:
* Sum exceeds the maximum payload size, prune fromcardlen1
ok
Quoted 21 lines
Quoted 21 lines
drivers/s390/crypto/zcrypt_msgtype6.c +8
-0+* (always trust fromcardlen2) +*/ +if (delta > msg->hdr.fromcardlen1) { + rc = -EINVAL ; + goto out; + } + msg->hdr.fromcardlen1 -= delta; + }drivers/s390/crypto/zcrypt_msgtype6.c +0
-0init_completion (&rtype->work); rc =ap_queue_message (zq->queue, ap_msg);@@ -1240,7 +1261,7 @@ static long zcrypt_msgtype6_send_ep11_cprb(booluserspace, struct
zcrypt_queue*drivers/s390/crypto/zcrypt_msgtype6.c +1
-1* as reply limit for the card firmware. */ msg->hdr.fromcardlen1 = zq->reply.bufsize - -sizeof (struct type86_hdr ) -sizeof (struct type86_fmt2_ext ); +sizeof (struct type86_reply_hdrs );init_completion (&rtype->work); rc =ap_queue_message (zq->queue, ap_msg);