Send the osTicket ticket text raw after the data: prefix, with no encoding

Percent-encoding put "%20" in every space of a real ticket, and the base64 that replaced it arrived
as base64. osTicket (Format::parseRfc2397, via ApiJsonDataParser::fixup) takes the message's type from the
"data:" prefix and uses everything after the first comma exactly as it is, decoding nothing; its own
documented example is plain text after the comma. The text is now sent raw (JSON takes care of quotes and
line breaks; later commas are fine, since only the first one splits).

The test now mimics that parsing -- split at the first comma, decode nothing -- and requires the text to
arrive exactly as written; it fails if percent-encoding or base64 comes back. The stand-in server in the
earlier test had decoded the encoding, which is why neither mistake was caught. INTEGRATIONS.md says what
happened and that it hasn't been re-checked against a real osTicket.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
bobbanandClaude Sonnet 5.5 committed 2026-10-08 00:11:27 +02:00
1 parent 5072cee519
commit 5386c1abe7
3 files changed
+15 -12

No files matched your search

+5 -4
View File
@@ -164,10 +164,11 @@ the dashboard views themselves load fine.
here is yours to close in osTicket. here is yours to close in osTicket.
- **Only partly verified against a real osTicket.** It was built from osTicket's published API documentation and - **Only partly verified against a real osTicket.** It was built from osTicket's published API documentation and
tested against a stand-in server that checks what is sent (the key header, the JSON fields, the message encoding, tested against a stand-in server that checks what is sent (the key header, the JSON fields, the message encoding,
and how each answer — created, refused key, bad request, redirect — is handled). The first test ticket sent to a and how each answer — created, refused key, bad request, redirect — is handled). Tickets sent to a
real osTicket arrived with every space shown as `%20`: osTicket takes the message from a `data:` URL but does not real osTicket first arrived with every space shown as `%20`, then as base64: osTicket takes the message's type from a
decode percent-encoding, so the message is now sent as base64, which it does decode (not yet re-checked against a `data:` prefix but uses everything after the first comma exactly as it is, decoding nothing (its source and its own
real osTicket). If osTicket rejects a ticket, "Send a test ticket" shows the reason it gave. documented example agree). The text is now sent raw after the prefix (not yet re-checked against a real osTicket). If
osTicket rejects a ticket, "Send a test ticket" shows the reason it gave.
### phpIPAM ### phpIPAM
@@ -106,9 +106,11 @@ export function createOsTicketTicketApi(config: OsTicketApiConfig) {
name: ticket.name, name: ticket.name,
email: ticket.email, email: ticket.email,
subject: ticket.subject, subject: ticket.subject,
// osTicket reads the type of the message from an RFC 2397 data URL. Base64, not percent-encoding: osTicket strips the // osTicket takes the message's type from a "data:" prefix, and then uses everything after the FIRST comma exactly as it is:
// "data:" part but leaves percent-encoded text as it is (a test ticket arrived full of %20), while base64 is decoded. // it does no decoding of any kind (percent-encoded text arrived as "%20"s, base64 as base64), and its own documented example is
message: `data:text/plain;charset=utf-8;base64,${Buffer.from(ticket.message, "utf8").toString("base64")}`, // plain text after the comma. So the text goes in raw. JSON takes care of quotes and line breaks, and any further commas are
// fine — osTicket splits at the first one only.
message: `data:text/plain;charset=utf-8,${ticket.message}`,
...(ticket.topicId ? { topicId: ticket.topicId } : {}), ...(ticket.topicId ? { topicId: ticket.topicId } : {}),
...(ticket.priorityId ? { priority: ticket.priorityId } : {}), ...(ticket.priorityId ? { priority: ticket.priorityId } : {}),
}); });
+5 -5
View File
@@ -229,11 +229,11 @@ describe("osTicket API client", () => {
assert.equal(s.body.source, "API"); assert.equal(s.body.source, "API");
assert.equal(s.body.alert, true); assert.equal(s.body.alert, true);
assert.equal(s.body.autorespond, false, "an acknowledgement to the app's own address would only bounce"); assert.equal(s.body.autorespond, false, "an acknowledgement to the app's own address would only bounce");
// osTicket reads a message's type from an RFC 2397 data URL. It must be base64: osTicket leaves percent-encoded text as it is, // What osTicket does with the message (include/class.format.php, parseRfc2397): split at the FIRST comma, use the rest as it is.
// which put "%20" in place of every space in a real ticket. // It applies no decoding, so any encoding here shows up in the ticket — percent-encoding as "%20", base64 as base64.
assert.match(s.body.message, /^data:text\/plain;charset=utf-8;base64,[A-Za-z0-9+/=]+$/); const comma = s.body.message.indexOf(",");
assert.doesNotMatch(s.body.message, /%[0-9A-Fa-f]{2}/, "percent-encoding ends up in the ticket as literal text"); assert.equal(s.body.message.slice(0, comma + 1), "data:text/plain;charset=utf-8,");
assert.equal(Buffer.from(s.body.message.replace(/^data:text\/plain;charset=utf-8;base64,/, ""), "base64").toString("utf8"), "Line one\nLine two — åäö ✓"); assert.equal(s.body.message.slice(comma + 1), "Line one\nLine two — åäö ✓", "the text must reach osTicket exactly as written");
}); });
test("topic and priority are sent only when set; staff alerts can be switched off", async () => { test("topic and priority are sent only when set; staff alerts can be switched off", async () => {