idnkit

-- internationalized domain name toolkit --

version 1.0

Japan Network Information Center (JPNIC)

Table of contents of this file:

1. Overview

2. Directory structure of this distribution

3. Supported systems

4. Contact information

See the file INSTALL for compilation and installation instructions.

See the file NEWS for a list of major changes in the current release.

1. Overview

idnkit, which was originally known as mDNkit, is a toolkit for handling

internationalized domain names. To handle such names, the following

features are required:

+ Encoding conversion

Multilingualized domain names have to be converted from

the encoding application uses (local encoding) to

the encoding used for name resolution (IDN encoding), and

vice versa. Since domain names in IDN encoding just look

like good old ASCII domain names, the encoding is also known

as ASCII-compatible encoding (ACE).

+ NAMEPREP

Name preparation of domain names before converting to

IDN encoding. Basically this is a normalization process

of the domain names.

These conversion/nameprep processes to domain names have to be

performed before they are sent to DNS servers. And since the

processed domain names (in IDN encoding) consist of only legal ASCII

characters, no changes are required to DNS servers.

idnkit provides several ways for adding these features.

This kit consists of following components.

+ library for handling internationalized domain names

(libidnkit, libidnkitlite)

Those libraries implement encoding conversion and nameprep.

They provide easy-to-use APIs for handling internationalized

domain name in your applications.

Both libraries provide almost the same API. The difference

between them is that libidnkit internally uses iconv() function

to provide encoding conversion from UTF-8 to the local encoding

(such as iso-8859-1, usually determined by the current locale),

and vise versa. The idnconv and runidn commands in this toolkit

use libidnkit.

libidnkitlite is lightweight version of libidnkit. It assumes

local encoding is UTF-8 so that it never uses iconv().

+ codeset conversion utility (idnconv)

This command can convert internationalized domain name written

in local encoding (e.g. EUC-JP) to ACE or the opposite direction.

It can also convert named.conf and zone master files for BIND.

+ command which adds IDN feature dynamically to unix applications

(runidn)

This command enables normal applications to handle

internationalized domain names by dynamically attaching special

library to them. See ``2. using runidn'' below.

Note that this command is not installed unless you specify the

`--enable-runidn' option to `configure'. See the file `INSTALL'

for more information about installation.

+ patch for BIND9 that adds IDN capability

This patch adds IDN capability to BIND9. It adds encoding

conversion and nameprep features to `dig', `host' and

`nslookup'. With the patch, those commands become capable of

internationalized domain names.

+ IDN wrapper for Windows applications

On windows, name resolving request is passed to WINSOCK DLL. So,

replacing WINSOCK DLL with multi-lingual domain name version

makes legacy windows applications compatible with IDN. This is

wrapper DLL for WINSOCK's name resolving functions. See

``3. using IDN wrapper'' below.

2. Directory structure of this distribution

Below is a directory structure of this distribution with some

important files and their brief description.

+README this file

+README.ja .. in Japanese

+INSTALL compilation and installation instructions.

+INSTALL.ja .. in Japanese

+DISTFILES list of files in this distribution

+NEWS what's new in this version

+ChangeLog list of changes

+Makefile.in toplevel makefile template

+configure a `configure' script

+include/

| +config.h.in template header file for configuration

| +idn/ header files for libidnkit and libindkitlite

| +mdn/ header files for backward compatibility

+lib/ source for libidnkit and libidnkitlite

+patch/

| +bind9/ BIND9 patch

+tools/

| +idnconv/ source for idnconv command

| +runidn/ source for runidn command

+util/ utilities

+wsock/ source for IDN wrapper

3. Supported systems

We've had successful builds on the following systems:

-------------------------------------------------------------------

OS iconv library configure options

===================================================================

FreeBSD 4.7-RELEASE GNU libiconv --with-libiconv

for Intel 1.8

-------------------------------------------------------------------

Red Hat Linux 7.3 standard library none

for Intel (glibc)

-------------------------------------------------------------------

Solaris 9 standard library none

for Sparc (libc)

-------------------------------------------------------------------

The latest information about supported/unsupported systems will be

found at the mdnkit FAQ page linked from:

http://www.nic.ad.jp/en/idn/

4. Contact information

Please see

http://www.nic.ad.jp/en/idn/

for the latest news about this kit.

Bug reports and comments on this kit should be sent to

mdnkit-bugs@nic.ad.jp

and

idn-cmt@nic.ad.jp

respectively.

; $Id: README,v 1.1 2003/06/04 00:24:58 marka Exp $

idnkit

-- $B9q:]2=%I%a%$%sL>%D!<%k%-%C%H(B --

$B%P!<%8%g%s(B 1.0

($B<R(B) $BF|K\%M%C%H%o!<%/%$%s%U%)%a!<%7%g%s%;%s%?!<(B (JPNIC)

$B$3$N%U%!%$%k$NL\<!(B:

1. $B35MW(B

2. $B%G%#%l%/%H%j9=@.(B

3. $BK\%-%C%H$,BP1~$7$F$$$k%7%9%F%`(B

4. $BK\%-%C%H$K4X$9$k:G?7>pJs!"Ld$$9g$o$;$K$D$$$F(B

$B%3%s%Q%$%k$*$h$S%$%s%9%H!<%kJ}K!$K$D$$$F$O!"(BINSTALL.ja $B$H$$$&%U%!%$%k$r(B

$B$4Mw2<$5$$!#$3$N%P!<%8%g%s$G$N<g$JJQ99E@$KIU$$$F$O!"(B($B1QJ8$G$9$,(B) NEWS

$B$H$$$&%U%!%$%k$r$4Mw2<$5$$!#(B

1. $B35MW(B

idnkit ($B5l>N(B mDNkit) $B$H$O9q:]2=%I%a%$%sL>$r07$&$?$a$N%D!<%k%-%C%H$G$9!#(B

$B9q:]2=%I%a%$%sL>$r07$&$?$a$K$O!"<!$N$h$&$J5!G=$,MW5a$5$l$^$9!#(B

$B!&%(%s%3!<%G%#%s%0JQ49(B

$B9q:]2=%I%a%$%sL>$KBP$7$F!"$=$N%(%s%3!<%G%#%s%0$r%"%W%j%1!<%7%g%s$,;H(B

$BMQ$7$F$$$k$b$N(B ($B%m!<%+%k%(%s%3!<%G%#%s%0(B) $B$+$iL>A02r7h$KMQ$$$i$l$k$b(B

$B$N(B (IDN $B%(%s%3!<%G%#%s%0(B) $B$X$NJQ49!"$^$?$=$N5UJ}8~$NJQ49$r9T$$$^$9!#(B

$B%I%a%$%sL>$r(B IDN $B%(%s%3!<%G%#%s%0$K$7$?7k2L$O!"=>Mh$N%I%a%$%sL>$HF1(B

$B$8$/(B ASCII $BJ8;z$N$_$G9=@.$5$l$k$N$G!"(BIDN $B%(%s%3!<%G%#%s%0$O(BASCII $B8_(B

$B49%(%s%3!<%G%#%s%0(B (ACE) $B$H$b8F$P$l$^$9!#(B

$B!&(BNAMEPREP

$B%I%a%$%sL>$r(B IDN $B%(%s%3!<%G%#%s%0$KJQ49$9$kA0$K!"L>A0$N@55,2=$r9T$$(B

$B$^$9!#$3$l$r(B NAMEPREP $B$H8F$S$^$9!#(B

$B>e5-$N=hM}$O%I%a%$%sL>$r(B DNS $B%5!<%P$KAw$kA0$K<B9T$9$kI,MW$,$"$j$^$9!#(B

$B=hM}:Q$N%I%a%$%sL>$O(B ASCII $BJ8;z$+$i9=@.$5$l!"=>Mh$N(B ASCII $B%I%a%$%sL>$H(B

$B$7$F$b@5$7$$7A<0$K$J$C$F$$$k$N$G!"(BDNS $B%5!<%PB&$K$O$J$s$NJQ99$bI,MW$"$j(B

$B$^$;$s!#(B

$B$3$NG[I[%-%C%H$K$O<!$N$h$&$J$b$N$,4^$^$l$^$9!#(B

$B!&9q:]2=%I%a%$%sL>$r=hM}$9$k$?$a$N%i%$%V%i%j(B (libidnkit, libidnkitlite)

$B$3$l$i$N%i%$%V%i%j$G$O!"%(%s%3!<%G%#%s%0JQ49$d(B NAMEPREP $B$N5!G=$r<B(B

$BAu$7$F$*$j!"%"%W%j%1!<%7%g%s$,9q:]2=%I%a%$%sL>$r4JC1$K07$($k$h$&$K(B

$B$9$k$?$a$N(B API $B$rHw$($F$$$^$9!#(B

$B$I$A$i$N%i%$%V%i%j$b$[$H$s$IF1$8(B API $B$rDs6!$7$^$9!#N><T$NAj0cE@$G$9(B

$B$,!"(Blibidnkit $B$N$[$&$O(B iconv() $B4X?t$r;H$C$F(B UTF-8 $B$H%m!<%+%k%(%s%3!<(B

$B%G%#%s%0(B (iso-8859-1 $B$J$I!"DL>o$O(B locale $B$+$i7hDj$5$l$^$9(B) $B$H$N4V$N(B

$BJQ495!G=$rDs6!$7$F$$$^$9!#K\%D!<%k%-%C%HIUB0$N(B idnconv $B$*$h$S(B runidn

$B$O(B libidnkit $B$r;HMQ$7$F$$$^$9!#(B

libidnkitlite $B$O(B libidnkit $B$N7ZNLHG$G$9!#%m!<%+%k%(%s%3!<%G%#%s%0$O(B

$B>o$K(B UTF-8 $B$@$H2>Dj$7$F$*$j!"(Biconv() $B$O;HMQ$7$^$;$s!#(B

$B!&%3!<%I%;%C%H%3%s%P!<%?(B (idnconv)

$B%m!<%+%k%(%s%3!<%G%#%s%0(B ($B$?$H$($P(B EUC-JP) $B$G=q$+$l$?9q:]2=%I%a%$%s(B

$BL>$+$i(B ACE $B$X$NJQ49$d!"$=$N5UJQ49$r9T$($k%3%^%s%I$G$9!#(BBIND $BMQ$N(B

named.conf $B$d%>!<%s%^%9%?%U%!%$%k$rJQ49$9$k$3$H$b2DG=$G$9!#(B

$B!&(BUNIX $B%"%W%j%1!<%7%g%s$K(B IDN $B5!G=$rF0E*$KDI2C$9$k%3%^%s%I(B (runidn)

UNIX $B$NDL>o$N%"%W%j%1!<%7%g%s$G9q:]2=%I%a%$%sL>$r<h$j07$&$?$a$K!"FC(B

$BJL$J%i%$%V%i%j$rF0E*$K%j%s%/$9$k$?$a$N%3%^%s%I$G$9!#>\$7$/$O!"8e=R$N(B

$B!V(B2. runidn $B$r;H$&!W$r8fMw$/$@$5$$!#(B

$B$J$*!"(Bconfigure $B<B9T;~$K(B `--enable-runidn' $B$r;XDj$7$J$$$H!"(Brunidn $B$O(B

$B%$%s%9%H!<%k$5$l$^$;$s!#%$%s%9%H!<%k$K4X$7$F!">\$7$/$O(B INSTALL.ja $B$H(B

$B$$$&%U%!%$%k$r$4Mw$/$@$5$$!#(B

$B!&(BBIND9 $B$K(B IDN $B5!G=$rDI2C$9$k%Q%C%A(B

BIND $B$K(B IDN $B$N5!G=$rDI2C$9$k%Q%C%A$G$9!#(B`dig'$B!"(B`host'$B!"(B`nslookup' $B$K(B

$B%(%s%3!<%G%#%s%0JQ49$H(B NAMEPREP $B$N5!G=$rDI2C$7!"9q:]2=%I%a%$%sL>$,07(B

$B$($k$h$&$K$7$^$9!#(B

$B!&(BWindows $B%"%W%j%1!<%7%g%sMQ$N(B IDN $B%i%C%Q!<(B

WINSOCK $B$NL>A02r7h5!G=$KBP$9$k%i%C%Q!<(B DLL $B$G$9!#(BWindows $B>e$G$O!"L>(B

$BA02r7h$NMW5a$O!"(BWINSOCK DLL $B$rDL$7$F9T$o$l$^$9!#$=$3$G!"$3$l$r9q:]2=(B

$B%I%a%$%sMQ$N(B WINSOCK DLL $B$KCV$-49$($k$3$H$G!"=>Mh$N(B Windows $B%"%W%j%1!<(B

$B%7%g%s$G$b(B IDN $B5!G=$r;HMQ$G$-$k$h$&$K$7$^$9!#>\$7$/$O!"8e=R$N(B

$B!V(B3. IDN $B%i%C%Q!<$r;H$&!W$r8fMw$/$@$5$$!#(B

2. $B%G%#%l%/%H%j9=@.(B

$BG[I[%-%C%H$N%G%#%l%/%H%j9=@.$H!"<gMW$J%U%!%$%k$r<($7$^$9!#(B

+README $B1Q8lHG$N(B README

+README.ja $B$3$N%U%!%$%k(B

+INSTALL $B1Q8lHG$N(B INSTALL

+INSTALL.ja $B%3%s%Q%$%k$H%$%s%9%H!<%kJ}K!(B

+DISTFILES $BG[I[$5$l$k%U%!%$%k0lMw(B

+NEWS $B<g$JJQ99(B

+ChangeLog $BJQ99>\:Y(B

+configure configure $B%9%/%j%W%H(B

+Makefile.in $B%H%C%W%l%Y%k$N(B Makefile $B$N%F%s%W%l!<%H(B

+include/

| +config.h.in config.h $B$N%F%s%W%l!<%H(B

| +idn/ libidnkit, libidnkitlite $B$N%X%C%@%U%!%$%k(B

| +mdn/ $B5l%P!<%8%g%s$H$N8_49MQ%X%C%@%U%!%$%k(B

+lib/ libidnkit, libidnkitlite $B$N%=!<%9(B

+patch/

| +bind9/ BIND9 $BMQ%Q%C%A(B

+tools/

| +idnconv/ idnconv $B%3%^%s%I$N%=!<%9(B

| +runidn/ runidn $B%3%^%s%I$N%=!<%9(B

+util/ $B%f!<%F%#%j%F%#(B

+wsock/ IDN $B%i%C%Q!<$N%=!<%9(B

3. $BK\%-%C%H$,BP1~$7$F$$$k%7%9%F%`(B

$B@5>o$K%$%s%9%H!<%k$G$-$k$3$H$,3NG'$G$-$F$$$k$N$O!"<!$N%7%9%F%`$G$9!#(B

------------------------------------------------------------------

OS iconv configure $B$N%*%W%7%g%s(B

==================================================================

FreeBSD 4.7-RELEASE GNU libiconv --with-libiconv

Intel 1.8

-------------------------------------------------------------------

Red Hat Linux 7.3 $BI8=`%i%$%V%i%j(B $B$J$7(B

Intel (glibc)

------------------------------------------------------------------

Solaris 9 $BI8=`%i%$%V%i%j(B $B$J$7(B

Sparc (libc)

-------------------------------------------------------------------

$BK\%-%C%H$,BP1~$7$F$$$k(B/$B$7$F$$$J$$%7%9%F%`$K4X$9$k:G?7$N>pJs$O!"<!$N$H(B

$B$3$m$+$iC)$l$k(B mdnkit FAQ $B$N%Z!<%8$K5-$5$l$F$$$^$9!#(B

http://www.nic.ad.jp/ja/idn/

4. $BK\%-%C%H$K4X$9$k:G?7>pJs!"Ld$$9g$o$;$K$D$$$F(B

$BK\%-%C%H$K4X$9$k:G?7>pJs$K$D$$$F$O!"(B

http://www.nic.ad.jp/ja/idn/

$B$r;2>H$7$F$/$@$5$$(B

$BK\%-%C%H$K4X$9$k%P%0%l%]!<%H$*$h$S%3%a%s%H$O!"$=$l$>$l(B

mdnkit-bugs@nic.ad.jp

$B$*$h$S(B

idn-cmt@nic.ad.jp

$B$X$*4j$$$7$^$9!#(B

; $Id: README.ja,v 1.1 2003/06/04 00:24:59 marka Exp $