Punycode is a representation of Unicode with the limited ASCII character subset used for Internet hostnames. Using Punycode, host names containing Unicode characters are transcoded to a subset of ASCII consisting of letters, digits, and hyphens, which is called the letter–digit–hyphen (LDH) subset. For example, München (German name for Munich) is encoded as Mnchen-3ya.
While the Domain Name System (DNS) technically supports arbitrary sequences of octets in domain name labels, the DNS standards recommend the use of the LDH subset of ASCII conventionally used for host names, and require that string comparisons between DNS domain names should be case-insensitive. The Punycode syntax is a method of encoding strings containing Unicode characters, such as internationalized domain names (IDNA), into the LDH subset of ASCII favored by DNS. It is specified in IETF Request for Comments 3492.
As stated in RFC 3492, "Punycode is an instance of a more general algorithm called Bootstring, which allows strings composed from a small set of 'basic' code points to uniquely represent any string of code points drawn from a larger set." Punycode defines parameters for the general Bootstring algorithm to match the characteristics of Unicode text. This section demonstrates the procedure for Punycode encoding, using the example of the string "bücher" (Bücher is German for books), which is translated into the label "bcher-kva".
First, all ASCII characters in the string are copied from input to output, skipping over any other characters. For example, "bücher" is copied to "bcher". If any characters were copied, i.e. if there was at least one ASCII character in the input, an ASCII hyphen is appended to the output (e.g., "bücher" → "bcher-", but "ü" → "").
Note that hyphens are themselves ASCII characters. Thus, they can be present in the input and, if so, they will be copied to the output. This causes no ambiguity: if the output contains hyphens, the one that got added is always the last one. It marks the end of the ASCII characters.
For each non-ASCII character in the input, the encoder calculates two numbers:
The encoder then calculates i*n, and encodes the resulting number into a sequence of base-36 digits. It renders those in ASCII, and appends the result to the output string.
The ASCII rendering is: 0 → 'a', ..., 25 → 'z', 26 → '0', ..., 35 → '9', with the number's digits arranged in little-endian order.
The base-36 encoding process is more complex. It outputs variable-length integers. These have the property that each number's most significant digit (e.g. the digit "1" in the number "123") is recognizable without context. Thus, the digits from multiple numbers can be concatenated, with nothing separating them, yet the original numbers can still be recognized and extracted.
Main article: Internationalized domain name
To prevent hyphens in non-international domain names from triggering a Punycode decoding, the string
xn-- is prepended to Punycode sequences in internationalized domain names. This is called ACE (ASCII Compatible Encoding).
Thus the domain name "bücher.tld" would be represented in ASCII as "xn--bcher-kva.tld".
The decoder is a finite-state machine with two state variables i and n.
i is an index into the string, ranging from zero (representing a potential insertion at the start) to the current length of the extended string (representing a potential insertion at the end). i starts at zero.
n starts at 128 (the first non-ASCII code point).
The state progression is a monotonic function. A state transition either increments i or, if i is at its maximum, resets i to zero and increments n. At the next state transition, we resume incrementing i. At each state, the code point denoted by n either gets inserted or not.
The numbers generated by the encoder represent how many possibilities to skip before an insertion is made.
There are six possible places to insert a character in the string "bcher" (including before the first character and after the last one). There are 124 code points between the last ASCII code point (127 = 0x7F, the end of ASCII) and "ü" (code point 252 = 0xFC, see Unicode's Latin-1 Supplement). There is one insertion position for the "ü" that must be skipped (position zero: before the 'b').
Thus, the decoder will skip a total of (6 × 124) + 1 = 745 possible insertions before reaching the required one. Once the character is inserted, there are now seven possible places to insert another character.
Punycode uses generalized variable-length integers to represent these values. For example, this is how "kva" is used to represent the code number 745:
A number system with little-endian ordering is used which allows variable-length codes without separate delimiters: a digit lower than a threshold value marks that it is the most-significant digit, hence the end of the number. The threshold value depends on the position in the number and also on previous insertions, to increase efficiency. Correspondingly the weights of the digits vary.
In this case a number system with 36 symbols is used, with the case-insensitive 'a' through 'z' equal to the decimal numbers 0 through 25, and '0' through '9' equal to the decimal numbers 26 through 35. Thus "kva", corresponds to the decimal number string "10 21 0".
To decode this string of symbols, a sequence of thresholds will be needed, in this case it's (1, 1, 26, 26, ...). The weight (or place value) of the least-significant digit is always 1: 'k' (=10) with a weight of 1 equals 10. After this, the weight of the next digit depends on the first threshold: generally, for any n, the weight of the (n+1)-th digit is the weight of the previous one times (36 − threshold of the n-th digit). So the second symbol has a place value of 36 minus the previous threshold value, in this case, 35. Therefore, the sum of the first two symbols 'k' (=10) and 'v' (=21) is 10 × 1 + 21 × 35. Since the second symbol is not less than its threshold value of 1, there is more to come. However, since the third symbol in this example is 'a' (=0), we may ignore calculating its weight. Therefore, "kva" represents the decimal number (10 × 1) + (21 × 35) = 745. The thresholds themselves are determined for each successive encoded character by an algorithm keeping them between 1 and 26 inclusive. The case can then be used to provide information about the original case of the string. Because special characters are sorted by their code points by encoding algorithm, for the insertion of a second special character in "bücher", the first possibility is "büücher" with code "bcher-kvaa", the second "bücüher" with code "bcher-kvab", etc. After "bücherü" with code "bcher-kvae" comes codes representing insertion of ý, the Unicode character following ü, starting with "ýbücher" with code "bcher-kvaf" (different from "übücher" coded "bcher-jvab"), etc.
To make the encoding and decoding algorithms simple, no attempt has been made to prevent some encoded values from encoding inadmissible Unicode values: however, these should be checked for and detected during decoding.
Punycode is designed to work across all scripts, and to be self-optimizing by attempting to adapt to the character set ranges within the string as it operates. It is optimized for the case where the string is composed of zero or more ASCII characters and in addition characters from only one other script system, but will cope with any arbitrary Unicode string. Note that for DNS use, the domain name string is assumed to have been normalized using nameprep and (for top-level domains) filtered against an officially registered language table before being punycoded, and that the DNS protocol sets limits on the acceptable lengths of the output Punycode string.
The following table shows examples of Punycode encodings for different types of input.
|Input||Punycode of input||Description of input|
|The empty string.|
|a||a-||Only ASCII characters, one, lowercase.|
|A||A-||Only ASCII characters, one, uppercase.|
|3||3-||Only ASCII characters, one, a digit.|
|-||--||Only ASCII characters, one, a hyphen.|
|--||---||Only ASCII characters, two hyphens.|
|London||London-||Only ASCII characters, more than one, no hyphens.|
|Lloyd-Atkinson||Lloyd-Atkinson-||Only ASCII characters, one hyphen.|
|This has spaces||This has spaces-||Only ASCII characters, with spaces.|
|-> $1.00 <-||-> $1.00 <--||Only ASCII characters, mixed symbols.|
|а||80a||No ASCII characters, one Cyrillic character.|
|ü||tda||No ASCII characters, one Latin-1 Supplement character.|
|α||mxa||No ASCII characters, one Greek character.|
|例||fsq||No ASCII characters, one CJK character.|
|😉||n28h||No ASCII characters, one emoji character.|
|αβγ||mxacd||No ASCII characters, more than one character.|
|München||Mnchen-3ya||Mixed string, with one character that is not an ASCII character.|
|Mnchen-3ya||Mnchen-3ya-||Double-encoded Punycode of "München".|
|München-Ost||Mnchen-Ost-9db||Mixed string, with one character that is not ASCII, and a hyphen.|
|Bahnhof München-Ost||Bahnhof Mnchen-Ost-u6b||Mixed string, with one space, one hyphen, and one character that is not ASCII.|
|abæcdöef||abcdef-qua4k||Mixed string, two non-ASCII characters.|
|правда||80aafi6cg||Russian, without ASCII.|
|ยจฆฟคฏข||22cdfh1b8fsa||Thai, without ASCII.|
|도메인||hq1bm8jm9l||Korean, without ASCII.|
|ドメイン名例||eckwd4c7cu47r2wf||Japanese, without ASCII.|
|MajiでKoiする5秒前||MajiKoi5-783gue6qz075azm5e||Japanese with ASCII.|
|「bücher」||bcher-kva8445foa||Mixed non-ASCII scripts (Latin-1 Supplement and CJK).|
s.encode("punycode")). See talk page.