Skip to content

Commit

Permalink
ses: sanitize illegal strings in SES element descriptors
Browse files Browse the repository at this point in the history
The SES4r3 standard requires that element descriptors may only contain ASCII
characters in the range 0x20 to 0x7e.  Some SuperMicro expanders violate
that rule.  This patch adds a sanity check to ses(4).  Descriptors in
violation will be replaced by "<invalid>".

This patch fixes "sesutil --libxo xml" on such systems.  Previously it would
generate non-well-formed XML output.

PR:		241929
Reviewed by:	allanjude
MFC after:	2 weeks
Sponsored by:	Axcient
  • Loading branch information
asomers committed Dec 6, 2019
1 parent 458bedb commit 6e2c3cd
Showing 1 changed file with 32 additions and 2 deletions.
34 changes: 32 additions & 2 deletions sys/cam/scsi/scsi_enc_ses.c
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ typedef struct ses_addl_status {
typedef struct ses_element {
uint8_t eip; /* eip bit is set */
uint16_t descr_len; /* length of the descriptor */
char *descr; /* descriptor for this object */
const char *descr; /* descriptor for this object */
struct ses_addl_status addl; /* additional status info */
} ses_element_t;

Expand Down Expand Up @@ -1977,6 +1977,35 @@ ses_publish_cache(enc_softc_t *enc, struct enc_fsm_state *state,
return (0);
}

/*
* \brief Sanitize an element descriptor
*
* The SES4r3 standard, sections 3.1.2 and 6.1.10, specifies that element
* descriptors may only contain ASCII characters in the range 0x20 to 0x7e.
* But some vendors violate that rule. Ensure that we only expose compliant
* descriptors to userland.
*
* \param desc SES element descriptor as reported by the hardware
* \param len Length of desc in bytes, not necessarily including
* trailing NUL. It will be modified if desc is invalid.
*/
static const char*
ses_sanitize_elm_desc(const char *desc, uint16_t *len)
{
const char *invalid = "<invalid>";
int i;

for (i = 0; i < *len; i++) {
if (desc[i] < 0x20 || desc[i] > 0x7e) {
*len = strlen(invalid);
return (invalid);
} else if (desc[i] == 0) {
break;
}
}
return (desc);
}

/**
* \brief Parse the descriptors for each object.
*
Expand Down Expand Up @@ -2061,7 +2090,8 @@ ses_process_elm_descs(enc_softc_t *enc, struct enc_fsm_state *state,
if (length > 0) {
elmpriv = element->elm_private;
elmpriv->descr_len = length;
elmpriv->descr = &buf[offset];
elmpriv->descr = ses_sanitize_elm_desc(&buf[offset],
&elmpriv->descr_len);
}

/* skip over the descriptor itself */
Expand Down

0 comments on commit 6e2c3cd

Please sign in to comment.