Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use URL encoding for binary values #69

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft

Use URL encoding for binary values #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0d7ce2
serialization: escape all bytes except known characters
saper Sep 27, 2024
0528728
serialization: unescape URL encoded values
saper Sep 27, 2024
4fe8d58
serialization: use URL encoding
saper Sep 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions lib/_pkcs11h-util.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,15 +74,17 @@ _pkcs11h_util_binaryToHex (
OUT char * const target,
IN const size_t target_size,
IN const unsigned char * const source,
IN const size_t source_size
IN const size_t source_size,
IN int url_escape
);

CK_RV
_pkcs11h_util_escapeString (
IN OUT char * const target,
IN const char * const source,
IN size_t * const max,
IN const char * const invalid_chars
IN const char * const invalid_chars,
IN int url_escape
);

CK_RV
Expand Down
30 changes: 20 additions & 10 deletions lib/pkcs11h-serialization.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,10 @@
#include "_pkcs11h-token.h"
#include "_pkcs11h-certificate.h"

#define __PKCS11H_SERIALIZE_INVALID_CHARS "\\/\"'%&#@!?$* <>{}[]()`|:;,.+-"
#define __PKCS11H_SERIALIZE_AS_PKCS11_URI 1
#define __PKCS11H_SERIALIZE_VALID_CHARS "abcdefghijklmnopqrstuvwxyz" \
"ABCDEFGHIJKLMNOPQRSTUVWXYZ" \
"0123456789_-."

#if defined(ENABLE_PKCS11H_TOKEN) || defined(ENABLE_PKCS11H_CERTIFICATE)

Expand Down Expand Up @@ -99,7 +102,8 @@ pkcs11h_token_serializeTokenId (
NULL,
sources[e],
&t,
__PKCS11H_SERIALIZE_INVALID_CHARS
__PKCS11H_SERIALIZE_VALID_CHARS,
__PKCS11H_SERIALIZE_AS_PKCS11_URI
)) != CKR_OK
) {
goto cleanup;
Expand All @@ -121,7 +125,8 @@ pkcs11h_token_serializeTokenId (
sz+n,
sources[e],
&t,
__PKCS11H_SERIALIZE_INVALID_CHARS
__PKCS11H_SERIALIZE_VALID_CHARS,
__PKCS11H_SERIALIZE_AS_PKCS11_URI
)) != CKR_OK
) {
goto cleanup;
Expand Down Expand Up @@ -325,7 +330,7 @@ pkcs11h_certificate_serializeCertificateId (
goto cleanup;
}

_max = n + certificate_id->attrCKA_ID_size*2 + 1;
_max = n + certificate_id->attrCKA_ID_size*3 + 1;

if (sz != NULL) {
if (saved_max < _max) {
Expand All @@ -334,12 +339,17 @@ pkcs11h_certificate_serializeCertificateId (
}

sz[n-1] = '/';
rv = _pkcs11h_util_binaryToHex (
sz+n,
saved_max-n,
certificate_id->attrCKA_ID,
certificate_id->attrCKA_ID_size
);
if (
(rv = _pkcs11h_util_binaryToHex (
sz+n,
saved_max-n,
certificate_id->attrCKA_ID,
certificate_id->attrCKA_ID_size,
__PKCS11H_SERIALIZE_AS_PKCS11_URI
)) != CKR_OK
) {
goto cleanup;
}
Copy link
Member Author

@saper saper Sep 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we don't check the error code here, an unmodified "empty" target buffer will be returned in case _pkcs11h_util_binaryToHex fails. This could go into master anyway.

}

*max = _max;
Expand Down
62 changes: 43 additions & 19 deletions lib/pkcs11h-util.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,23 +122,29 @@ _pkcs11h_util_binaryToHex (
OUT char * const target,
IN const size_t target_size,
IN const unsigned char * const source,
IN const size_t source_size
IN const size_t source_size,
IN int url_escape
) {
static const char *x = "0123456789ABCDEF";
size_t i;
size_t i, t;
size_t bytes_per_esc = url_escape ? 3 : 2;

_PKCS11H_ASSERT (target!=NULL);
_PKCS11H_ASSERT (source!=NULL);

if (target_size < source_size * 2 + 1) {
if (target_size < source_size * bytes_per_esc + 1) {
return CKR_ATTRIBUTE_VALUE_INVALID;
}

for (i=0;i<source_size;i++) {
target[i*2] = x[(source[i]&0xf0)>>4];
target[i*2+1] = x[(source[i]&0x0f)>>0];
t = i*bytes_per_esc;
if (url_escape) {
target[t++] = '%';
}
target[t++] = x[(source[i]&0xf0)>>4];
target[t++] = x[(source[i]&0x0f)>>0];
}
target[source_size*2] = '\x0';
target[source_size*bytes_per_esc] = '\x0';

return CKR_OK;
}
Expand All @@ -148,35 +154,44 @@ _pkcs11h_util_escapeString (
IN OUT char * const target,
IN const char * const source,
IN size_t * const max,
IN const char * const invalid_chars
IN const char * const valid_chars,
IN const int url_escape
) {
static const char *x = "0123456789ABCDEF";
CK_RV rv = CKR_FUNCTION_FAILED;
const char *s = source;
char *t = target;
size_t n = 0;
size_t bytes_per_esc = url_escape ? 3 : 4;

/*_PKCS11H_ASSERT (target!=NULL); Not required*/
_PKCS11H_ASSERT (source!=NULL);
_PKCS11H_ASSERT (max!=NULL);

while (*s != '\x0') {

if (*s == '\\' || strchr (invalid_chars, (unsigned char)*s) || !isgraph (*s)) {
if (!strchr (valid_chars, (unsigned char)*s)) {
if (t != NULL) {
if (n+4 > *max) {
if (n+bytes_per_esc > *max) {
rv = CKR_ATTRIBUTE_VALUE_INVALID;
goto cleanup;
}
else {
t[0] = '\\';
t[1] = 'x';
t[2] = x[(*s&0xf0)>>4];
t[3] = x[(*s&0x0f)>>0];
t+=4;
if (url_escape) {
t[0] = '%';
t[1] = x[(*s&0xf0)>>4];
t[2] = x[(*s&0x0f)>>0];
t+=3;
} else {
t[0] = '\\';
t[1] = 'x';
t[2] = x[(*s&0xf0)>>4];
t[3] = x[(*s&0x0f)>>0];
t+=4;
}
}
}
n+=4;
n+=bytes_per_esc;
}
else {
if (t != NULL) {
Expand Down Expand Up @@ -225,13 +240,22 @@ _pkcs11h_util_unescapeString (
const char *s = source;
char *t = target;
size_t n = 0;
size_t bytes_per_esc;
int high_nibble_pos;

/*_PKCS11H_ASSERT (target!=NULL); Not required*/
_PKCS11H_ASSERT (source!=NULL);
_PKCS11H_ASSERT (max!=NULL);

while (*s != '\x0') {
if (*s == '\\') {
if (*s == '\\' || *s == '%') {
if (*s == '%') {
bytes_per_esc = 3;
high_nibble_pos = 1;
} else {
bytes_per_esc = 4;
high_nibble_pos = 2;
}
if (t != NULL) {
if (n+1 > *max) {
rv = CKR_ATTRIBUTE_VALUE_INVALID;
Expand All @@ -240,15 +264,15 @@ _pkcs11h_util_unescapeString (
else {
char b[3];
unsigned u;
b[0] = s[2];
b[1] = s[3];
b[0] = s[high_nibble_pos];
b[1] = s[high_nibble_pos+1];
b[2] = '\x0';
sscanf (b, "%08x", &u);
*t = (char)(u & 0xff);
t++;
}
}
s+=4;
s+=bytes_per_esc;
}
else {
if (t != NULL) {
Expand Down
Loading