From 9a065ead487d1d655b8a73e84ee68e2c51ee21b0 Mon Sep 17 00:00:00 2001 From: Alex Wilson Date: Fri, 31 Oct 2014 17:25:24 +1000 Subject: os_mon: cpu_sup should use native sysctl/libkvm calls on BSD This avoids forking off with os:cmd every time we just want to collect the load averages. riak does this every second, which results in a lot of unnecessary load. --- lib/os_mon/c_src/cpu_sup.c | 108 ++++++++++++++++++++++++++++++++++++++++++++- lib/os_mon/src/cpu_sup.erl | 84 +++++++---------------------------- 2 files changed, 121 insertions(+), 71 deletions(-) (limited to 'lib') diff --git a/lib/os_mon/c_src/cpu_sup.c b/lib/os_mon/c_src/cpu_sup.c index e9fd75a32c..4198cc73f3 100644 --- a/lib/os_mon/c_src/cpu_sup.c +++ b/lib/os_mon/c_src/cpu_sup.c @@ -31,13 +31,27 @@ #include #include +#if (defined(__APPLE__) && defined(__MACH__)) || defined(__OpenBSD__) || defined(__FreeBSD__) || defined(__DragonFly__) +#include +#include +#include +#include +#endif +#if defined(__FreeBSD__) || defined(__DragonFly__) +#include +#include +#endif + #if defined(__sun__) #include #endif -#include #include +#if defined(__sun__) || defined(__linux__) +#include +#endif + #if defined(__linux__) #include /* strlen */ @@ -128,6 +142,11 @@ static void send(unsigned int data); static void sendv(unsigned int data[], int ints); static void error(char* err_msg); +#if (defined(__APPLE__) && defined(__MACH__)) || defined(__OpenBSD__) || defined(__FreeBSD__) || defined(__DragonFly__) +static void bsd_count_procs(void); +static void bsd_loadavg(int); +#endif + #if defined(__sun__) static kstat_ctl_t *kstat_ctl; #endif @@ -179,14 +198,98 @@ int main(int argc, char** argv) { case AVG1: send(misc_measure("avenrun_1min")); break; case AVG5: send(misc_measure("avenrun_5min")); break; case AVG15: send(misc_measure("avenrun_15min")); break; +#elif defined(__OpenBSD__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD__) || defined(__DragonFly__) + case NPROCS: bsd_count_procs(); break; + case AVG1: bsd_loadavg(0); break; + case AVG5: bsd_loadavg(1); break; + case AVG15: bsd_loadavg(2); break; #endif +#if defined(__sun__) || defined(__linux__) case UTIL: util_measure(&rv,&sz); sendv(rv, sz); break; +#endif case QUIT: free((void*)rv); return 0; default: error("Bad command"); break; } } return 0; /* supress warnings */ } + +/* ---------------------------- * + * BSD stat functions * + * ---------------------------- */ +#if defined(__OpenBSD__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD__) || defined(__DragonFly__) + +static void bsd_loadavg(int idx) { + double avgs[3]; + if (getloadavg(avgs, 3) < 0) { + error(strerror(errno)); + return; + } + send((unsigned int)(avgs[idx] * 256)); +} + +#endif + +#if defined(__OpenBSD__) + +static void bsd_count_procs(void) { + int err, nproc; + size_t len = sizeof(nproc); + int mib[] = { CTL_KERN, KERN_NPROCS }; + + err = sysctl(mib, sizeof(mib) / sizeof(mib[0]), &nproc, &len, NULL, 0); + if (err) { + error(strerror(errno)); + return; + } + + send((unsigned int)nproc); +} + +#elif defined(__FreeBSD__) || defined(__DragonFly__) + +static void bsd_count_procs(void) { + kvm_t *kd; + struct kinfo_proc *kp; + char err[_POSIX2_LINE_MAX]; + int cnt = 0; + + if ((kd = kvm_open(NULL, "/dev/null", NULL, O_RDONLY, err)) == NULL) { + error(err); + return; + } + +#if defined(KERN_PROC_PROC) + if ((kp = kvm_getprocs(kd, KERN_PROC_PROC, 0, &cnt)) == NULL) { +#else + if ((kp = kvm_getprocs(kd, KERN_PROC_ALL, 0, &cnt)) == NULL) { +#endif + error(strerror(errno)); + return; + } + + (void)kvm_close(kd); + send((unsigned int)cnt); +} + +#elif (defined(__APPLE__) && defined(__MACH__)) + +static void bsd_count_procs(void) { + int err; + size_t len = 0; + int mib[] = { CTL_KERN, KERN_PROC, KERN_PROC_ALL }; + + err = sysctl(mib, sizeof(mib) / sizeof(mib[0]), NULL, &len, NULL, 0); + if (err) { + error(strerror(errno)); + return; + } + + send((unsigned int)(len / sizeof(struct kinfo_proc))); +} + +#endif + /* ---------------------------- * * Linux stat functions * * ---------------------------- */ @@ -474,7 +577,8 @@ static void error(char* err_msg) { buffer[i++] = '\n'; /* try to use one write only */ - if(write(FD_ERR, buffer, i)); + if(write(FD_ERR, buffer, i)) + ; exit(-1); } diff --git a/lib/os_mon/src/cpu_sup.erl b/lib/os_mon/src/cpu_sup.erl index 1f088ecbde..75d31ef703 100644 --- a/lib/os_mon/src/cpu_sup.erl +++ b/lib/os_mon/src/cpu_sup.erl @@ -217,8 +217,6 @@ code_change(_OldVsn, State, _Extra) -> %% internal functions %%---------------------------------------------------------------------- -get_uint32_measurement(Request, #internal{port = P, os_type = {unix, sunos}}) -> - port_server_call(P, Request); get_uint32_measurement(Request, #internal{os_type = {unix, linux}}) -> {ok,F} = file:open("/proc/loadavg",[read,raw]), {ok,D} = file:read(F,24), @@ -231,67 +229,13 @@ get_uint32_measurement(Request, #internal{os_type = {unix, linux}}) -> ?ping -> 4711; ?nprocs -> PTotal end; -get_uint32_measurement(Request, #internal{os_type = {unix, freebsd}}) -> - D = os:cmd("/sbin/sysctl -n vm.loadavg") -- "\n", - {ok,[Load1,Load5,Load15],_} = io_lib:fread("{ ~f ~f ~f }", D), - %% We could count the lines from the ps command as well - case Request of - ?avg1 -> sunify(Load1); - ?avg5 -> sunify(Load5); - ?avg15 -> sunify(Load15); - ?ping -> 4711; - ?nprocs -> - Ps = os:cmd("/bin/ps -ax | /usr/bin/wc -l"), - {ok, [N], _} = io_lib:fread("~d", Ps), - N-1 - end; -get_uint32_measurement(Request, #internal{os_type = {unix, dragonfly}}) -> - D = os:cmd("/sbin/sysctl -n vm.loadavg") -- "\n", - {ok,[Load1,Load5,Load15],_} = io_lib:fread("{ ~f ~f ~f }", D), - %% We could count the lines from the ps command as well - case Request of - ?avg1 -> sunify(Load1); - ?avg5 -> sunify(Load5); - ?avg15 -> sunify(Load15); - ?ping -> 4711; - ?nprocs -> - Ps = os:cmd("/bin/ps -ax | /usr/bin/wc -l"), - {ok, [N], _} = io_lib:fread("~d", Ps), - N-1 - end; -get_uint32_measurement(Request, #internal{os_type = {unix, openbsd}}) -> - D = os:cmd("/sbin/sysctl -n vm.loadavg") -- "\n", - {ok, [L1, L5, L15], _} = io_lib:fread("~f ~f ~f", D), - case Request of - ?avg1 -> sunify(L1); - ?avg5 -> sunify(L5); - ?avg15 -> sunify(L15); - ?ping -> 4711; - ?nprocs -> - Ps = os:cmd("/bin/ps -ax | /usr/bin/wc -l"), - {ok, [N], _} = io_lib:fread("~d", Ps), - N-1 - end; -get_uint32_measurement(Request, #internal{os_type = {unix, darwin}}) -> - %% Get the load average using uptime, overriding Locale setting. - D = os:cmd("LANG=C LC_ALL=C uptime") -- "\n", - %% Here is a sample uptime string from Mac OS 10.3.8 (C Locale): - %% "11:17 up 12 days, 20:39, 2 users, load averages: 1.07 0.95 0.66" - %% The safest way to extract the load averages seems to be grab everything - %% after the last colon and then do an fread on that. - Avg = lists:reverse(hd(string:tokens(lists:reverse(D), ":"))), - {ok,[L1,L5,L15],_} = io_lib:fread("~f ~f ~f", Avg), - - case Request of - ?avg1 -> sunify(L1); - ?avg5 -> sunify(L5); - ?avg15 -> sunify(L15); - ?ping -> 4711; - ?nprocs -> - Ps = os:cmd("/bin/ps -ax | /usr/bin/wc -l"), - {ok, [N], _} = io_lib:fread("~d", Ps), - N-1 - end; +get_uint32_measurement(Request, #internal{port = P, os_type = {unix, Sys}}) when + Sys == sunos; + Sys == dragonfly; + Sys == openbsd; + Sys == freebsd; + Sys == darwin -> + port_server_call(P, Request); get_uint32_measurement(Request, #internal{os_type = {unix, Sys}}) when Sys == irix64; Sys == irix -> %% Get the load average using uptime. @@ -541,14 +485,16 @@ measurement_server_init() -> process_flag(trap_exit, true), OS = os:type(), Server = case OS of - {unix, Flavor} when Flavor==sunos; - Flavor==linux -> - {ok, Pid} = port_server_start_link(), - Pid; - {unix, Flavor} when Flavor==darwin; + {unix, Flavor} when + Flavor==sunos; + Flavor==linux; + Flavor==darwin; Flavor==freebsd; Flavor==dragonfly; - Flavor==openbsd; + Flavor==openbsd -> + {ok, Pid} = port_server_start_link(), + Pid; + {unix, Flavor} when Flavor==irix64; Flavor==irix -> not_used; -- cgit v1.2.3 From a13e075a25d27e690e68f9205e9d546559f3a294 Mon Sep 17 00:00:00 2001 From: Alex Wilson Date: Mon, 3 Nov 2014 09:31:43 +1000 Subject: os_mon: rename send() to sendi() in cpu_sup.c Without this, cpu_sup.c won't compile on FreeBSD, as the name overlaps with the send() socket call. --- lib/os_mon/c_src/cpu_sup.c | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) (limited to 'lib') diff --git a/lib/os_mon/c_src/cpu_sup.c b/lib/os_mon/c_src/cpu_sup.c index 4198cc73f3..20bb9ce391 100644 --- a/lib/os_mon/c_src/cpu_sup.c +++ b/lib/os_mon/c_src/cpu_sup.c @@ -138,7 +138,7 @@ static void util_measure(unsigned int **result_vec, int *result_sz); #if defined(__sun__) static unsigned int misc_measure(char* name); #endif -static void send(unsigned int data); +static void sendi(unsigned int data); static void sendv(unsigned int data[], int ints); static void error(char* err_msg); @@ -192,12 +192,12 @@ int main(int argc, char** argv) { error("Erlang has closed"); switch(cmd) { - case PING: send(4711); break; + case PING: sendi(4711); break; #if defined(__sun__) - case NPROCS: send(misc_measure("nproc")); break; - case AVG1: send(misc_measure("avenrun_1min")); break; - case AVG5: send(misc_measure("avenrun_5min")); break; - case AVG15: send(misc_measure("avenrun_15min")); break; + case NPROCS: sendi(misc_measure("nproc")); break; + case AVG1: sendi(misc_measure("avenrun_1min")); break; + case AVG5: sendi(misc_measure("avenrun_5min")); break; + case AVG15: sendi(misc_measure("avenrun_15min")); break; #elif defined(__OpenBSD__) || (defined(__APPLE__) && defined(__MACH__)) || defined(__FreeBSD__) || defined(__DragonFly__) case NPROCS: bsd_count_procs(); break; case AVG1: bsd_loadavg(0); break; @@ -225,7 +225,7 @@ static void bsd_loadavg(int idx) { error(strerror(errno)); return; } - send((unsigned int)(avgs[idx] * 256)); + sendi((unsigned int)(avgs[idx] * 256)); } #endif @@ -243,7 +243,7 @@ static void bsd_count_procs(void) { return; } - send((unsigned int)nproc); + sendi((unsigned int)nproc); } #elif defined(__FreeBSD__) || defined(__DragonFly__) @@ -269,7 +269,7 @@ static void bsd_count_procs(void) { } (void)kvm_close(kd); - send((unsigned int)cnt); + sendi((unsigned int)cnt); } #elif (defined(__APPLE__) && defined(__MACH__)) @@ -285,7 +285,7 @@ static void bsd_count_procs(void) { return; } - send((unsigned int)(len / sizeof(struct kinfo_proc))); + sendi((unsigned int)(len / sizeof(struct kinfo_proc))); } #endif @@ -523,7 +523,7 @@ static void util_measure(unsigned int **result_vec, int *result_sz) { * Generic functions * * ---------------------------- */ -static void send(unsigned int data) { sendv(&data, 1); } +static void sendi(unsigned int data) { sendv(&data, 1); } static void sendv(unsigned int data[], int ints) { static unsigned char *buf = NULL; -- cgit v1.2.3 From 65d41cb6c514308ab11645dc2d0842d4f6b629a4 Mon Sep 17 00:00:00 2001 From: Vlad Dumitrescu Date: Thu, 12 Mar 2015 23:04:30 +0100 Subject: OTP-11660: make eunit unicode safe All output from eunit is unicode, including the surefire XML files. --- lib/eunit/include/eunit.hrl | 6 +++--- lib/eunit/src/eunit.erl | 2 +- lib/eunit/src/eunit_data.erl | 2 +- lib/eunit/src/eunit_internal.hrl | 4 ++-- lib/eunit/src/eunit_lib.erl | 42 ++++++++++++++++++++-------------------- lib/eunit/src/eunit_proc.erl | 7 ++----- lib/eunit/src/eunit_surefire.erl | 27 ++++++++++++++++++++------ lib/eunit/src/eunit_tty.erl | 24 +++++++++++------------ lib/eunit/test/Makefile | 4 +++- lib/eunit/test/eunit_SUITE.erl | 38 ++++++++++++++++++++++++++---------- lib/eunit/test/tlatin.erl | 15 ++++++++++++++ lib/eunit/test/tutf8.erl | 15 ++++++++++++++ 12 files changed, 124 insertions(+), 62 deletions(-) create mode 100644 lib/eunit/test/tlatin.erl create mode 100644 lib/eunit/test/tutf8.erl (limited to 'lib') diff --git a/lib/eunit/include/eunit.hrl b/lib/eunit/include/eunit.hrl index 9e8d34567a..53d291430d 100644 --- a/lib/eunit/include/eunit.hrl +++ b/lib/eunit/include/eunit.hrl @@ -414,7 +414,7 @@ -else. -define(debugMsg(S), begin - io:fwrite(user, <<"~s:~w:~w: ~s\n">>, + io:fwrite(user, <<"~ts:~w:~w: ~ts\n">>, [?FILE, ?LINE, self(), S]), ok end). @@ -423,7 +423,7 @@ -define(debugVal(E), begin ((fun (__V) -> - ?debugFmt(<<"~s = ~P">>, [(??E), __V, 15]), + ?debugFmt(<<"~ts = ~tP">>, [(??E), __V, 15]), __V end)(E)) end). @@ -433,7 +433,7 @@ {__T0, _} = statistics(wall_clock), __V = (E), {__T1, _} = statistics(wall_clock), - ?debugFmt(<<"~s: ~.3f s">>, [(S), (__T1-__T0)/1000]), + ?debugFmt(<<"~ts: ~.3f s">>, [(S), (__T1-__T0)/1000]), __V end)()) end). diff --git a/lib/eunit/src/eunit.erl b/lib/eunit/src/eunit.erl index 9c589dfa86..fbfd123c43 100644 --- a/lib/eunit/src/eunit.erl +++ b/lib/eunit/src/eunit.erl @@ -231,7 +231,7 @@ event_logger(LogFile) -> event_logger_loop(Reference, FD) -> receive {status, _Id, _Info}=Msg -> - io:fwrite(FD, "~p.\n", [Msg]), + io:fwrite(FD, "~tp.\n", [Msg]), event_logger_loop(Reference, FD); {stop, Reference, _ReplyTo} -> %% no need to reply, just exit diff --git a/lib/eunit/src/eunit_data.erl b/lib/eunit/src/eunit_data.erl index cbbc6fbc15..8b53a3681d 100644 --- a/lib/eunit/src/eunit_data.erl +++ b/lib/eunit/src/eunit_data.erl @@ -391,7 +391,7 @@ parse({with, X, As}=T) when is_list(As) -> parse({S, T1} = T) when is_list(S) -> case eunit_lib:is_string(S) of true -> - group(#group{tests = T1, desc = list_to_binary(S)}); + group(#group{tests = T1, desc = unicode:characters_to_binary(S)}); false -> bad_test(T) end; diff --git a/lib/eunit/src/eunit_internal.hrl b/lib/eunit/src/eunit_internal.hrl index 92694ec39b..8e1e27811f 100644 --- a/lib/eunit/src/eunit_internal.hrl +++ b/lib/eunit/src/eunit_internal.hrl @@ -14,8 +14,8 @@ -define(DEFAULT_MODULE_WRAPPER_NAME, eunit_wrapper_). -ifdef(DEBUG). --define(debugmsg(S),io:fwrite("\n* ~s: ~s\n", [?MODULE,S])). --define(debugmsg1(S,As),io:fwrite("\n* ~s: " ++ S ++ "\n", [?MODULE] ++ As)). +-define(debugmsg(S),io:fwrite("\n* ~ts: ~ts\n", [?MODULE,S])). +-define(debugmsg1(S,As),io:fwrite("\n* ~ts: " ++ S ++ "\n", [?MODULE] ++ As)). -else. -define(debugmsg(S),ok). -define(debugmsg1(S,As),ok). diff --git a/lib/eunit/src/eunit_lib.erl b/lib/eunit/src/eunit_lib.erl index 40bae93298..d8f98cffa5 100644 --- a/lib/eunit/src/eunit_lib.erl +++ b/lib/eunit/src/eunit_lib.erl @@ -57,7 +57,7 @@ format_exception({Class,Term,Trace}, Depth) when is_atom(Class), is_list(Trace) -> case is_stacktrace(Trace) of true -> - io_lib:format("~s**~w:~s", + io_lib:format("~ts**~w:~ts", [format_stacktrace(Trace), Class, format_term(Term, Depth)]); false -> @@ -67,11 +67,11 @@ format_exception(Term, Depth) -> format_term(Term, Depth). format_term(Term, Depth) -> - io_lib:format("~P\n", [Term, Depth]). + io_lib:format("~tP\n", [Term, Depth]). format_exit_term(Term) -> {Reason, Trace} = analyze_exit_term(Term), - io_lib:format("~P~s", [Reason, 15, Trace]). + io_lib:format("~tP~ts", [Reason, 15, Trace]). analyze_exit_term({Reason, [_|_]=Trace}=Term) -> case is_stacktrace(Trace) of @@ -102,7 +102,7 @@ format_stacktrace(Trace) -> format_stacktrace(Trace, "in function", "in call from"). format_stacktrace([{M,F,A,L}|Fs], Pre, Pre1) when is_integer(A) -> - [io_lib:fwrite("~s ~w:~w/~w~s\n", + [io_lib:fwrite("~ts ~w:~w/~w~ts\n", [Pre, M, F, A, format_stacktrace_location(L)]) | format_stacktrace(Fs, Pre1, Pre1)]; format_stacktrace([{M,F,As,L}|Fs], Pre, Pre1) when is_list(As) -> @@ -110,15 +110,15 @@ format_stacktrace([{M,F,As,L}|Fs], Pre, Pre1) when is_list(As) -> C = case is_op(M,F,A) of true when A =:= 1 -> [A1] = As, - io_lib:fwrite("~s ~s", [F,format_arg(A1)]); + io_lib:fwrite("~ts ~ts", [F,format_arg(A1)]); true when A =:= 2 -> [A1, A2] = As, - io_lib:fwrite("~s ~s ~s", + io_lib:fwrite("~ts ~ts ~ts", [format_arg(A1),F,format_arg(A2)]); false -> - io_lib:fwrite("~w(~s)", [F,format_arglist(As)]) + io_lib:fwrite("~w(~ts)", [F,format_arglist(As)]) end, - [io_lib:fwrite("~s ~w:~w/~w~s\n called as ~s\n", + [io_lib:fwrite("~ts ~w:~w/~w~ts\n called as ~ts\n", [Pre,M,F,A,format_stacktrace_location(L),C]) | format_stacktrace(Fs,Pre1,Pre1)]; format_stacktrace([{M,F,As}|Fs], Pre, Pre1) -> @@ -130,18 +130,18 @@ format_stacktrace_location(Location) -> File = proplists:get_value(file, Location), Line = proplists:get_value(line, Location), if File =/= undefined, Line =/= undefined -> - io_lib:format(" (~s, line ~w)", [File, Line]); + io_lib:format(" (~ts, line ~w)", [File, Line]); true -> "" end. format_arg(A) -> - io_lib:format("~P",[A,15]). + io_lib:format("~tP",[A,15]). format_arglist([A]) -> format_arg(A); format_arglist([A|As]) -> - [io_lib:format("~P,",[A,15]) | format_arglist(As)]; + [io_lib:format("~tP,",[A,15]) | format_arglist(As)]; format_arglist([]) -> "". @@ -155,41 +155,41 @@ is_op(_M, _F, _A) -> false. format_error({bad_test, Term}) -> - error_msg("bad test descriptor", "~P", [Term, 15]); + error_msg("bad test descriptor", "~tP", [Term, 15]); format_error({bad_generator, {{M,F,A}, Term}}) -> error_msg(io_lib:format("result from generator ~w:~w/~w is not a test", [M,F,A]), - "~P", [Term, 15]); + "~tP", [Term, 15]); format_error({generator_failed, {{M,F,A}, Exception}}) -> error_msg(io_lib:format("test generator ~w:~w/~w failed",[M,F,A]), - "~s", [format_exception(Exception)]); + "~ts", [format_exception(Exception)]); format_error({no_such_function, {M,F,A}}) when is_atom(M), is_atom(F), is_integer(A) -> error_msg(io_lib:format("no such function: ~w:~w/~w", [M,F,A]), "", []); format_error({module_not_found, M}) -> - error_msg("test module not found", "~p", [M]); + error_msg("test module not found", "~tp", [M]); format_error({application_not_found, A}) when is_atom(A) -> error_msg("application not found", "~w", [A]); format_error({file_read_error, {_R, Msg, F}}) -> - error_msg("error reading file", "~s: ~s", [Msg, F]); + error_msg("error reading file", "~ts: ~ts", [Msg, F]); format_error({setup_failed, Exception}) -> - error_msg("context setup failed", "~s", + error_msg("context setup failed", "~ts", [format_exception(Exception)]); format_error({cleanup_failed, Exception}) -> - error_msg("context cleanup failed", "~s", + error_msg("context cleanup failed", "~ts", [format_exception(Exception)]); format_error({{bad_instantiator, {{M,F,A}, Term}}, _DummyException}) -> error_msg(io_lib:format("result from instantiator ~w:~w/~w is not a test", [M,F,A]), - "~P", [Term, 15]); + "~tP", [Term, 15]); format_error({instantiation_failed, Exception}) -> - error_msg("instantiation of subtests failed", "~s", + error_msg("instantiation of subtests failed", "~ts", [format_exception(Exception)]). error_msg(Title, Fmt, Args) -> Msg = io_lib:format("**"++Fmt, Args), % gets indentation right - io_lib:fwrite("*** ~s ***\n~s\n\n", [Title, Msg]). + io_lib:fwrite("*** ~ts ***\n~ts\n\n", [Title, Msg]). -ifdef(TEST). format_exception_test_() -> diff --git a/lib/eunit/src/eunit_proc.erl b/lib/eunit/src/eunit_proc.erl index 03d1a18321..98ae31d54b 100644 --- a/lib/eunit/src/eunit_proc.erl +++ b/lib/eunit/src/eunit_proc.erl @@ -230,7 +230,7 @@ insulator_wait(Child, Parent, Buf, St) -> message_super(Id, {progress, 'begin', {Type, Data}}, St), insulator_wait(Child, Parent, [[] | Buf], St); {child, Child, Id, {'end', Status, Time}} -> - Data = [{time, Time}, {output, buffer_to_binary(hd(Buf))}], + Data = [{time, Time}, {output, lists:reverse(hd(Buf))}], message_super(Id, {progress, 'end', {Status, Data}}, St), insulator_wait(Child, Parent, tl(Buf), St); {child, Child, Id, {skipped, Reason}} -> @@ -272,9 +272,6 @@ kill_task(Child, St) -> exit(Child, kill), terminate_insulator(St). -buffer_to_binary([B]) when is_binary(B) -> B; % avoid unnecessary copying -buffer_to_binary(Buf) -> list_to_binary(lists:reverse(Buf)). - %% Unlinking before exit avoids polluting the parent process with exit %% signals from the insulator. The child process is already dead here. @@ -597,7 +594,7 @@ group_leader_loop(Runner, Wait, Buf) -> %% no more messages and nothing to wait for; we ought to %% have collected all immediately pending output now process_flag(priority, normal), - Runner ! {self(), buffer_to_binary(Buf)} + Runner ! {self(), lists:reverse(Buf)} end. group_leader_sync(G) -> diff --git a/lib/eunit/src/eunit_surefire.erl b/lib/eunit/src/eunit_surefire.erl index 2d1f0b1497..d6684f33cb 100644 --- a/lib/eunit/src/eunit_surefire.erl +++ b/lib/eunit/src/eunit_surefire.erl @@ -206,6 +206,7 @@ handle_cancel(test, Data, St) -> format_name({Module, Function, Arity}, Line) -> lists:flatten([atom_to_list(Module), ":", atom_to_list(Function), "/", integer_to_list(Arity), "_", integer_to_list(Line)]). + format_desc(undefined) -> ""; format_desc(Desc) when is_binary(Desc) -> @@ -279,7 +280,7 @@ write_report_to(TestSuite, FileDescriptor) -> %% Write the XML header. %% ---------------------------------------------------------------------------- write_header(FileDescriptor) -> - file:write(FileDescriptor, [<<"">>, ?NEWLINE]). + io:format(FileDescriptor, "~ts~ts", [<<"">>, ?NEWLINE]). %% ---------------------------------------------------------------------------- %% Write the testsuite start tag, with attributes describing the statistics @@ -303,7 +304,7 @@ write_start_tag( <<"\" time=\"">>, format_time(Time), <<"\" name=\"">>, escape_attr(Name), <<"\">">>, ?NEWLINE], - file:write(FileDescriptor, StartTag). + io:format(FileDescriptor, "~ts", [StartTag]). %% ---------------------------------------------------------------------------- %% Recursive function to write the test cases. @@ -317,7 +318,7 @@ write_testcases([TestCase| Tail], FileDescriptor) -> %% Write the testsuite end tag. %% ---------------------------------------------------------------------------- write_end_tag(FileDescriptor) -> - file:write(FileDescriptor, [<<"">>, ?NEWLINE]). + io:format(FileDescriptor, "~ts~ts", [<<"">>, ?NEWLINE]). %% ---------------------------------------------------------------------------- %% Write a test case, as a testcase tag. @@ -344,7 +345,7 @@ write_testcase( {ok, <<>>} -> [<<"/>">>, ?NEWLINE]; _ -> [<<">">>, ?NEWLINE, format_testcase_result(Result), format_testcase_output(Output), ?INDENT, <<"">>, ?NEWLINE] end, - file:write(FileDescriptor, [StartTag, ContentAndEndTag]). + io:format(FileDescriptor, "~ts~ts", [StartTag, ContentAndEndTag]). %% ---------------------------------------------------------------------------- %% Format the result of the test. @@ -427,7 +428,7 @@ escape_suitename([Char | Tail], Acc) -> escape_suitename(Tail, [Char | Acc]). %% Replace < with <, > with > and & with & %% ---------------------------------------------------------------------------- escape_text(Text) when is_binary(Text) -> escape_text(binary_to_list(Text)); -escape_text(Text) -> escape_xml(lists:flatten(Text), [], false). +escape_text(Text) -> escape_xml(to_utf8(lists:flatten(Text)), [], false). %% ---------------------------------------------------------------------------- @@ -435,7 +436,7 @@ escape_text(Text) -> escape_xml(lists:flatten(Text), [], false). %% Replace < with <, > with > and & with & %% ---------------------------------------------------------------------------- escape_attr(Text) when is_binary(Text) -> escape_attr(binary_to_list(Text)); -escape_attr(Text) -> escape_xml(lists:flatten(Text), [], true). +escape_attr(Text) -> escape_xml(to_utf8(lists:flatten(Text)), [], true). escape_xml([], Acc, _ForAttr) -> lists:reverse(Acc); escape_xml([$< | Tail], Acc, ForAttr) -> escape_xml(Tail, [$;, $t, $l, $& | Acc], ForAttr); @@ -443,3 +444,17 @@ escape_xml([$> | Tail], Acc, ForAttr) -> escape_xml(Tail, [$;, $t, $g, $& | Acc] escape_xml([$& | Tail], Acc, ForAttr) -> escape_xml(Tail, [$;, $p, $m, $a, $& | Acc], ForAttr); escape_xml([$" | Tail], Acc, true) -> escape_xml(Tail, [$;, $t, $o, $u, $q, $& | Acc], true); % " escape_xml([Char | Tail], Acc, ForAttr) when is_integer(Char) -> escape_xml(Tail, [Char | Acc], ForAttr). + +%% the input may be utf8 or latin1; the resulting list is unicode +to_utf8(Desc) when is_binary(Desc) -> + case unicode:characters_to_list(Desc) of + {_,_,_} -> unicode:characters_to_list(Desc, latin1); + X -> X + end; +to_utf8(Desc) when is_list(Desc) -> + try + to_utf8(list_to_binary(Desc)) + catch + _:_ -> + Desc + end. diff --git a/lib/eunit/src/eunit_tty.erl b/lib/eunit/src/eunit_tty.erl index f21b2da3d3..699d2adaca 100644 --- a/lib/eunit/src/eunit_tty.erl +++ b/lib/eunit/src/eunit_tty.erl @@ -83,7 +83,7 @@ terminate({ok, Data}, St) -> sync_end(error) end; terminate({error, Reason}, _St) -> - fwrite("Internal error: ~P.\n", [Reason, 25]), + fwrite("Internal error: ~tP.\n", [Reason, 25]), sync_end(error). sync_end(Result) -> @@ -177,7 +177,7 @@ indent(_N) -> print_group_start(I, Desc) -> indent(I), - fwrite("~s\n", [Desc]). + fwrite("~ts\n", [Desc]). print_group_end(I, Time) -> if Time > 0 -> @@ -195,13 +195,13 @@ print_test_begin(I, Data) -> true -> io_lib:fwrite("~w:", [Line]) end, D = if Desc =:= "" ; Desc =:= undefined -> ""; - true -> io_lib:fwrite(" (~s)", [Desc]) + true -> io_lib:fwrite(" (~ts)", [Desc]) end, case proplists:get_value(source, Data) of {Module, Name, _Arity} -> - fwrite("~s:~s ~s~s...", [Module, L, Name, D]); + fwrite("~ts:~ts ~ts~ts...", [Module, L, Name, D]); _ -> - fwrite("~s~s...", [L, D]) + fwrite("~ts~ts...", [L, D]) end. print_test_end(Data) -> @@ -209,21 +209,21 @@ print_test_end(Data) -> T = if Time > 0 -> io_lib:fwrite("[~.3f s] ", [Time/1000]); true -> "" end, - fwrite("~sok\n", [T]). + fwrite("~tsok\n", [T]). print_test_error({error, Exception}, Data) -> Output = proplists:get_value(output, Data), - fwrite("*failed*\n~s", [eunit_lib:format_exception(Exception)]), + fwrite("*failed*\n~ts", [eunit_lib:format_exception(Exception)]), case Output of <<>> -> fwrite("\n\n"); <> -> - fwrite(" output:<<\"~s\">>...\n\n", [Text]); + fwrite(" output:<<\"~ts\">>...\n\n", [Text]); _ -> - fwrite(" output:<<\"~s\">>\n\n", [Output]) + fwrite(" output:<<\"~ts\">>\n\n", [Output]) end; print_test_error({skipped, Reason}, _) -> - fwrite("*did not run*\n::~s\n", [format_skipped(Reason)]). + fwrite("*did not run*\n::~ts\n", [format_skipped(Reason)]). format_skipped({module_not_found, M}) -> io_lib:fwrite("missing module: ~w", [M]); @@ -244,12 +244,12 @@ format_cancel(undefined) -> format_cancel(timeout) -> "*timed out*\n"; format_cancel({startup, Reason}) -> - io_lib:fwrite("*could not start test process*\n::~P\n\n", + io_lib:fwrite("*could not start test process*\n::~tP\n\n", [Reason, 15]); format_cancel({blame, _SubId}) -> "*cancelled because of subtask*\n"; format_cancel({exit, Reason}) -> - io_lib:fwrite("*unexpected termination of test process*\n::~P\n\n", + io_lib:fwrite("*unexpected termination of test process*\n::~tP\n\n", [Reason, 15]); format_cancel({abort, Reason}) -> eunit_lib:format_error(Reason). diff --git a/lib/eunit/test/Makefile b/lib/eunit/test/Makefile index e4ddf4e42c..b0dde64c67 100644 --- a/lib/eunit/test/Makefile +++ b/lib/eunit/test/Makefile @@ -20,7 +20,9 @@ include $(ERL_TOP)/make/target.mk include $(ERL_TOP)/make/$(TARGET)/otp.mk MODULES = \ - eunit_SUITE + eunit_SUITE \ + tlatin \ + tutf8 ERL_FILES= $(MODULES:%=%.erl) diff --git a/lib/eunit/test/eunit_SUITE.erl b/lib/eunit/test/eunit_SUITE.erl index d13dc73923..2ac6fafe5d 100644 --- a/lib/eunit/test/eunit_SUITE.erl +++ b/lib/eunit/test/eunit_SUITE.erl @@ -1,35 +1,35 @@ %% %% %CopyrightBegin% -%% +%% %% Copyright Ericsson AB 2010-2011. All Rights Reserved. -%% +%% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in %% compliance with the License. You should have received a copy of the %% Erlang Public License along with this software. If not, it can be %% retrieved online at http://www.erlang.org/. -%% +%% %% Software distributed under the License is distributed on an "AS IS" %% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See %% the License for the specific language governing rights and limitations %% under the License. -%% +%% %% %CopyrightEnd% %% -module(eunit_SUITE). --export([all/0, suite/0,groups/0,init_per_suite/1, end_per_suite/1, +-export([all/0, suite/0,groups/0,init_per_suite/1, end_per_suite/1, init_per_group/2,end_per_group/2, - app_test/1,appup_test/1,eunit_test/1]). - + app_test/1,appup_test/1,eunit_test/1,surefire_utf8_test/1,surefire_latin_test/1]). + -include_lib("common_test/include/ct.hrl"). suite() -> [{ct_hooks,[ts_install_cth]}]. -all() -> - [app_test, appup_test, eunit_test]. +all() -> + [app_test, appup_test, eunit_test, surefire_utf8_test, surefire_latin_test]. -groups() -> +groups() -> []. init_per_suite(Config) -> @@ -54,3 +54,21 @@ eunit_test(Config) when is_list(Config) -> ok = file:set_cwd(code:lib_dir(eunit)), ok = eunit:test(eunit). +surefire_latin_test(Config) when is_list(Config) -> + ok = file:set_cwd(proplists:get_value(priv_dir, Config, ".")), + check_surefire(tlatin), + ok. + +surefire_utf8_test(Config) when is_list(Config) -> + ok = file:set_cwd(proplists:get_value(priv_dir, Config, ".")), + check_surefire(tutf8), + ok. + +check_surefire(Module) -> + File = "TEST-"++atom_to_list(Module)++".xml", + file:delete(File), + % ignore test result, some fail on purpose + eunit:test(Module, [{report,{eunit_surefire,[{dir,"."}]}}]), + {ok, Bin} = file:read_file(File), + [_|_] = unicode:characters_to_list(Bin, unicode), + ok. \ No newline at end of file diff --git a/lib/eunit/test/tlatin.erl b/lib/eunit/test/tlatin.erl new file mode 100644 index 0000000000..a42e67d581 --- /dev/null +++ b/lib/eunit/test/tlatin.erl @@ -0,0 +1,15 @@ +% coding: latin-1 + +-module(tlatin). + +-include_lib("eunit/include/eunit.hrl"). + +'foo_ä_test_'() -> + [ + {"1ö1", fun() -> io:format("1å1 ~s ~w",[<<"aö">>, 'Zök']), io:format([128,64,255,255]), ?assert("gö"=="gö") end} + ,{<<"2ö2">>, fun() -> io:format("2å2 ~s",[<<"bö">>]), io:format([128,64]), ?assert("gö"=="gö") end} + ,{<<"3ö3"/utf8>>, fun() -> io:format("3å3 ~ts",[<<"cö"/utf8>>]), io:format([128,64]), ?assert("gö"=="gö") end} + ,{"1ä1", fun() -> io:format("1ä1 ~s ~w",[<<"aä">>,'Zbäd']), io:format([128,64,255,255]), ?assert("wå"=="wä") end} + ,{<<"2ä2">>, fun() -> io:format("2ä2 ~s",[<<"bä">>]), io:format([128,64]), ?assert("wå"=="wä") end} + ,{<<"3ä3"/utf8>>, fun() -> io:format("3ä3 ~ts",[<<"cä"/utf8>>]), io:format([128,64]), ?assert("wå"=="wä") end} + ]. diff --git a/lib/eunit/test/tutf8.erl b/lib/eunit/test/tutf8.erl new file mode 100644 index 0000000000..c902f3ad18 --- /dev/null +++ b/lib/eunit/test/tutf8.erl @@ -0,0 +1,15 @@ +%% coding: utf-8 + +-module(tutf8). + +-include_lib("eunit/include/eunit.hrl"). + +'foo_ö_test_'() -> + [ + {"1ö汉1", fun() -> io:format("1å汉1 ~s ~w",[<<"aö汉">>, 'Zök']), io:format([128,64,255,255]), ?assert("gö汉"=="gö汉") end} + ,{<<"2ö汉2">>, fun() -> io:format("2å汉2 ~s",[<<"bö汉">>]), io:format([128,64]), ?assert("gö汉"=="gö汉") end} + ,{<<"3ö汉3"/utf8>>, fun() -> io:format("3å汉3 ~ts",[<<"cö汉"/utf8>>]), io:format([128,64]), ?assert("gö汉"=="gö汉") end} + ,{"1ä汉1", fun() -> io:format("1ä汉1 ~s ~w",[<<"aä汉">>, 'Zbäd']), io:format([128,64,255,255]), ?assert("wå汉"=="wä汉") end} + ,{<<"2ä汉2">>, fun() -> io:format("2ä汉2 ~s",[<<"bä汉">>]), io:format([128,64]), ?assert("wå汉"=="wä汉") end} + ,{<<"3ä汉"/utf8>>, fun() -> io:format("3ä汉3 ~ts",[<<"cä汉"/utf8>>]), io:format([128,64]), ?assert("wå汉"=="wä汉") end} + ]. -- cgit v1.2.3 From cd932144bd4716b1fa311c909baf0beb3ca77d13 Mon Sep 17 00:00:00 2001 From: Anthony Ramine Date: Sat, 21 Mar 2015 13:11:28 +0100 Subject: Undocument the line macro in test_server Reported-by: Magnus Ottenklinger --- lib/test_server/doc/src/example_chapter.xml | 28 ++++++------ lib/test_server/doc/src/test_server.xml | 66 ++++++----------------------- 2 files changed, 28 insertions(+), 66 deletions(-) (limited to 'lib') diff --git a/lib/test_server/doc/src/example_chapter.xml b/lib/test_server/doc/src/example_chapter.xml index 0ebc85da09..6bc0cfaebe 100644 --- a/lib/test_server/doc/src/example_chapter.xml +++ b/lib/test_server/doc/src/example_chapter.xml @@ -47,7 +47,7 @@ -define(default_timeout, ?t:minutes(1)). init_per_testcase(_Case, Config) -> - ?line Dog=?t:timetrap(?default_timeout), + Dog=?t:timetrap(?default_timeout), [{watchdog, Dog}|Config]. end_per_testcase(_Case, Config) -> Dog=?config(watchdog, Config), @@ -72,8 +72,8 @@ not_started_func1(suite) -> not_started_func1(doc) -> ["Testing function 1 when application is not started"]. not_started_func1(Config) when list(Config) -> - ?line {error, not_started} = myapp:func1(dummy_ref,1), - ?line {error, not_started} = myapp:func1(dummy_ref,2), + {error, not_started} = myapp:func1(dummy_ref,1), + {error, not_started} = myapp:func1(dummy_ref,2), ok. not_started_func2(suite) -> @@ -81,8 +81,8 @@ not_started_func2(suite) -> not_started_func2(doc) -> ["Testing function 2 when application is not started"]. not_started_func2(Config) when list(Config) -> - ?line {error, not_started} = myapp:func2(dummy_ref,1), - ?line {error, not_started} = myapp:func2(dummy_ref,2), + {error, not_started} = myapp:func2(dummy_ref,1), + {error, not_started} = myapp:func2(dummy_ref,2), ok. @@ -90,7 +90,7 @@ not_started_func2(Config) when list(Config) -> start(doc) -> ["Testing start of my application."]; start(Config) when list(Config) -> - ?line Ref = myapp:start(), + Ref = myapp:start(), case erlang:whereis(my_main_process) of Pid when pid(Pid) -> [{myapp_ref,Ref}|Config]; @@ -105,9 +105,9 @@ func1(suite) -> func1(doc) -> ["Test that func1 returns ok when argument is 1 and error if argument is 2"]; func1(Config) when list(Config) -> - ?line Ref = ?config(myapp_ref,Config), - ?line ok = myapp:func1(Ref,1), - ?line error = myapp:func1(Ref,2), + Ref = ?config(myapp_ref,Config), + ok = myapp:func1(Ref,1), + error = myapp:func1(Ref,2), ok. func2(suite) -> @@ -115,17 +115,17 @@ func2(suite) -> func2(doc) -> ["Test that func1 returns ok when argument is 3 and error if argument is 4"]; func2(Config) when list(Config) -> - ?line Ref = ?config(myapp_ref,Config), - ?line ok = myapp:func2(Ref,3), - ?line error = myapp:func2(Ref,4), + Ref = ?config(myapp_ref,Config), + ok = myapp:func2(Ref,3), + error = myapp:func2(Ref,4), ok. %% No specification clause needed for a cleanup function in a conf case!!! stop(doc) -> ["Testing termination of my application"]; stop(Config) when list(Config) -> - ?line Ref = ?config(myapp_ref,Config), - ?line ok = myapp:stop(Ref), + Ref = ?config(myapp_ref,Config), + ok = myapp:stop(Ref), case erlang:whereis(my_main_process) of undefined -> lists:keydelete(myapp_ref,1,Config); diff --git a/lib/test_server/doc/src/test_server.xml b/lib/test_server/doc/src/test_server.xml index ed5569e1fe..b98e434c03 100644 --- a/lib/test_server/doc/src/test_server.xml +++ b/lib/test_server/doc/src/test_server.xml @@ -811,46 +811,12 @@ Only valid for peer nodes. Note that slave nodes always -
- TEST SUITE LINE NUMBERS -

If a test case fails, the test server can report the exact line - number at which it failed. There are two ways of doing this, - either by using the line macro or by using the - test_server_line parse transform. -

-

The line macro is described under TEST SUITE SUPPORT - MACROS below. The line macro will only report the last line - executed when a test case failed. -

-

The test_server_line parse transform is activated by - including the headerfile test_server_line.hrl in the test - suite. When doing this, it is important that the - test_server_line module is in the code path of the erlang - node compiling the test suite. The parse transform will report a - history of a maximum of 10 lines when a test case - fails. Consecutive lines in the same function are not shown. -

-

The attribute -no_lines(FuncList). can be used in the - test suite to exclude specific functions from the parse - transform. This is necessary e.g. for functions that are executed - on old (i.e. <R10B) OTP releases. FuncList = [{Func,Arity}]. -

-

If both the line macro and the parse transform is used in - the same module, the parse transform will overrule the macro. -

-
TEST SUITE SUPPORT MACROS

There are some macros defined in the test_server.hrl that are quite useful for test suite programmers:

-

The line macro, is quite - essential when writing test cases. It tells the test server - exactly what line of code that is being executed, so that it can - report this line back if the test case fails. Use this macro at - the beginning of every test case line of code. -

The config macro, is used to retrieve information from the Config variable sent to all test cases. It is used with two arguments, where the first is the @@ -867,24 +833,20 @@ Only valid for peer nodes. Note that slave nodes always Whatever added by conf test cases or init_per_testcase/2 -

Examples of the line and config macros can be - seen in the Examples chapter in the user's guide. -

-

If the line_trace macro is defined, you will get a - timestamp (erlang:now()) in your minor log for each - line macro in your suite. This way you can at any time see - which line is currently being executed, and when the line was - called. -

-

The line_trace macro can also be used together with the - test_server_line parse transform described above. A - timestamp will then be written for each line in the suite, except - for functions stated in the -no_lines attribute. -

-

The line_trace macro can e.g. be defined as a compile - option, like this: -

-erlc -W -Dline_trace my_SUITE.erl

+

Examples of the config macro can be seen in the Examples chapter + in the user's guide.

+

The line and line_trace macros are deprecated, see + below.

+
+ +
+ TEST SUITE LINE NUMBERS +

In the past, ERTS did not produce line numbers when generating + stacktraces, test_server was thus unable to provide them when reporting + test failures. It had instead two different mecanisms to do it: either by + using the line macro or by using the test_server_line parse + transform. Both are deprecated and should not be used in new tests + anymore.

-- cgit v1.2.3 From d8fa79149a1339b2359ecc981f992bd53e5a9d18 Mon Sep 17 00:00:00 2001 From: Anthony Ramine Date: Wed, 25 Mar 2015 13:59:26 +0100 Subject: Properly report unknown parse transforms We don't want undef errors coming from the parse transform itself to be confused with undef errors caused by the absence of the parse transform. Reported-by: Klas Johansson --- lib/compiler/src/compile.erl | 51 ++++++++++++++++++++++----------------- lib/compiler/test/error_SUITE.erl | 12 +++++++-- 2 files changed, 39 insertions(+), 24 deletions(-) (limited to 'lib') diff --git a/lib/compiler/src/compile.erl b/lib/compiler/src/compile.erl index c7d91070f6..60311ef002 100644 --- a/lib/compiler/src/compile.erl +++ b/lib/compiler/src/compile.erl @@ -906,28 +906,35 @@ transform_module(#compile{options=Opt,code=Code0}=St0) -> foldl_transform(St, [T|Ts]) -> Name = "transform " ++ atom_to_list(T), - Fun = fun(S) -> T:parse_transform(S#compile.code, S#compile.options) end, - Run = case member(time, St#compile.options) of - true -> fun run_tc/2; - false -> fun({_Name,F}, S) -> catch F(S) end - end, - case Run({Name, Fun}, St) of - {error,Es,Ws} -> - {error,St#compile{warnings=St#compile.warnings ++ Ws, - errors=St#compile.errors ++ Es}}; - {'EXIT',{undef,_}} -> - Es = [{St#compile.ifile,[{none,compile, - {undef_parse_transform,T}}]}], - {error,St#compile{errors=St#compile.errors ++ Es}}; - {'EXIT',R} -> - Es = [{St#compile.ifile,[{none,compile,{parse_transform,T,R}}]}], - {error,St#compile{errors=St#compile.errors ++ Es}}; - {warning, Forms, Ws} -> - foldl_transform( - St#compile{code=Forms, - warnings=St#compile.warnings ++ Ws}, Ts); - Forms -> - foldl_transform(St#compile{code=Forms}, Ts) + case code:ensure_loaded(T) =:= {module,T} andalso + erlang:function_exported(T, parse_transform, 2) of + true -> + Fun = fun(S) -> + T:parse_transform(S#compile.code, S#compile.options) + end, + Run = case member(time, St#compile.options) of + true -> fun run_tc/2; + false -> fun({_Name,F}, S) -> catch F(S) end + end, + case Run({Name, Fun}, St) of + {error,Es,Ws} -> + {error,St#compile{warnings=St#compile.warnings ++ Ws, + errors=St#compile.errors ++ Es}}; + {'EXIT',R} -> + Es = [{St#compile.ifile,[{none,compile, + {parse_transform,T,R}}]}], + {error,St#compile{errors=St#compile.errors ++ Es}}; + {warning, Forms, Ws} -> + foldl_transform( + St#compile{code=Forms, + warnings=St#compile.warnings ++ Ws}, Ts); + Forms -> + foldl_transform(St#compile{code=Forms}, Ts) + end; + false -> + Es = [{St#compile.ifile,[{none,compile, + {undef_parse_transform,T}}]}], + {error,St#compile{errors=St#compile.errors ++ Es}} end; foldl_transform(St, []) -> {ok,St}. diff --git a/lib/compiler/test/error_SUITE.erl b/lib/compiler/test/error_SUITE.erl index bd877bb528..8e79b88821 100644 --- a/lib/compiler/test/error_SUITE.erl +++ b/lib/compiler/test/error_SUITE.erl @@ -235,10 +235,18 @@ transforms(Config) -> ">>, {error,[{none,compile,{parse_transform,?MODULE,{too_bad,_}}}],[]} = run_test(Ts2, test_filename(Config), [], dont_write_beam), + Ts3 = <<" + -compile({parse_transform,",?MODULE_STRING,"}). + ">>, + {error,[{none,compile,{parse_transform,?MODULE,{undef,_}}}],[]} = + run_test(Ts3, test_filename(Config), [call_undef], dont_write_beam), ok. -parse_transform(_, _) -> - error(too_bad). +parse_transform(_, Opts) -> + case lists:member(call_undef, Opts) of + false -> error(too_bad); + true -> camembert:délicieux() + end. forbidden_maps(Config) when is_list(Config) -> -- cgit v1.2.3 From 96df4f39cdcd881303ac56bc96b84ae5f6f58c8d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Sch=C3=BCrrer?= Date: Wed, 22 Apr 2015 03:08:43 +0200 Subject: Remove erlang:display/1 calls --- lib/kernel/src/inet_tcp_dist.erl | 2 -- 1 file changed, 2 deletions(-) (limited to 'lib') diff --git a/lib/kernel/src/inet_tcp_dist.erl b/lib/kernel/src/inet_tcp_dist.erl index 835dcf2705..fb60a14afb 100644 --- a/lib/kernel/src/inet_tcp_dist.erl +++ b/lib/kernel/src/inet_tcp_dist.erl @@ -112,7 +112,6 @@ listen_options(Opts0) -> end, case application:get_env(kernel, inet_dist_listen_options) of {ok,ListenOpts} -> - erlang:display({inet_dist_listen_options, ListenOpts}), ListenOpts ++ Opts1; _ -> Opts1 @@ -340,7 +339,6 @@ do_setup(Kernel, Node, Type, MyNode, LongOrShortNames,SetupTime) -> connect_options(Opts) -> case application:get_env(kernel, inet_dist_connect_options) of {ok,ConnectOpts} -> - erlang:display({inet_dist_listen_options, ConnectOpts}), ConnectOpts ++ Opts; _ -> Opts -- cgit v1.2.3 From 95aff702b5e4b21ec277b1e0125f639ce30f997a Mon Sep 17 00:00:00 2001 From: Kenji Rikitake Date: Mon, 20 Apr 2015 14:27:26 +0200 Subject: stdlib: Add new random functionality/module The old random module contains an old algorithm which have flaws and the api requires the user to invoke seed and or checking if seed have been invoked, if a non constant seed is to be used. The api contains the following features: - The user can invoke rand:unform/[0|1] directly and get a non constant seeding. - The api is split in functional and non functional functions, i.e. usage of _s functions will not affect the process dictionary. - The api contains several algorithms with different characteristics and can be extended with new algorithms in the future. - Contains state of the art random number generators. - Default algorithm is taylor made for erlang to be fast on 64bits machines. --- lib/stdlib/src/Makefile | 1 + lib/stdlib/src/rand.erl | 302 +++++++++++++++++++++++++ lib/stdlib/src/stdlib.app.src | 1 + lib/stdlib/test/Makefile | 1 + lib/stdlib/test/rand_SUITE.erl | 496 +++++++++++++++++++++++++++++++++++++++++ 5 files changed, 801 insertions(+) create mode 100644 lib/stdlib/src/rand.erl create mode 100644 lib/stdlib/test/rand_SUITE.erl (limited to 'lib') diff --git a/lib/stdlib/src/Makefile b/lib/stdlib/src/Makefile index 1b3744b6fb..c983f0ed87 100644 --- a/lib/stdlib/src/Makefile +++ b/lib/stdlib/src/Makefile @@ -104,6 +104,7 @@ MODULES= \ qlc \ qlc_pt \ queue \ + rand \ random \ sets \ shell \ diff --git a/lib/stdlib/src/rand.erl b/lib/stdlib/src/rand.erl new file mode 100644 index 0000000000..0cafb35dd8 --- /dev/null +++ b/lib/stdlib/src/rand.erl @@ -0,0 +1,302 @@ +%% +%% %CopyrightBegin% +%% +%% Copyright Ericsson AB 2015. All Rights Reserved. +%% +%% The contents of this file are subject to the Erlang Public License, +%% Version 1.1, (the "License"); you may not use this file except in +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved online at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% %CopyrightEnd% +%% +%% ===================================================================== +%% Multiple PRNG module for Erlang/OTP +%% Copyright (c) 2015 Kenji Rikitake +%% ===================================================================== + +-module(rand). + +-export([seed_s/1, seed_s/2, seed/1, seed/2, + export_seed/0, export_seed_s/1, + uniform/0, uniform/1, uniform_s/1, uniform_s/2]). + +-compile({inline, [exs64_next/1, exsplus_next/1, + exs1024_next/1, exs1024_calc/2]}). + +-define(DEFAULT_ALG_HANDLER, exsplus). +-define(SEED_DICT, rand_seed). + +%% ===================================================================== +%% Types +%% ===================================================================== + +%% This depends on the algorithm handler function +-opaque alg_seed() :: exs64_state() | exsplus_state() | exs1024_state(). +%% This is the algorithm handler function within this module +-type alg_handler() :: #{type => alg(), + max => integer(), + uniform => fun(), + uniform_n => fun()}. + +%% Internal state +-type state() :: {alg_handler(), alg_seed()}. +-type alg() :: exs64 | exsplus | exs1024. +-export_type([alg/0, alg_handler/0, state/0, alg_seed/0]). + +%% ===================================================================== +%% API +%% ===================================================================== + +%% Return algorithm and seed so that RNG state can be recreated with seed/1 +-spec export_seed() -> undefined | {alg(), alg_seed()}. +export_seed() -> + case seed_get() of + {#{type:=Alg}, Seed} -> {Alg, Seed}; + _ -> undefined + end. + +-spec export_seed_s(state()) -> {alg(), alg_seed()}. +export_seed_s({#{type:=Alg}, Seed}) -> {Alg, Seed}. + +%% seed(Alg) seeds RNG with runtime dependent values +%% and return the NEW state + +%% seed({Alg,Seed}) setup RNG with a previously exported seed +%% and return the NEW state + +-spec seed(alg() | {alg(), alg_seed()}) -> state(). +seed(Alg) -> + R = seed_s(Alg), + _ = seed_put(R), + R. + +-spec seed_s(alg() | {alg(), alg_seed()}) -> state(). +seed_s(Alg) when is_atom(Alg) -> + seed_s(Alg, {erlang:phash2([{node(),self()}]), + erlang:system_time(), + erlang:unique_integer()}); +seed_s({Alg0, Seed}) -> + {Alg,_SeedFun} = mk_alg(Alg0), + {Alg, Seed}. + +%% seed/2: seeds RNG with the algorithm and given values +%% and returns the NEW state. + +-spec seed(Alg :: alg(), {integer(), integer(), integer()}) -> state(). +seed(Alg0, S0) -> + State = seed_s(Alg0, S0), + _ = seed_put(State), + State. + +-spec seed_s(Alg :: alg(), {integer(), integer(), integer()}) -> state(). +seed_s(Alg0, S0 = {_, _, _}) -> + {Alg, Seed} = mk_alg(Alg0), + AS = Seed(S0), + {Alg, AS}. + +%%% uniform/0, uniform/1, uniform_s/1, uniform_s/2 are all +%%% uniformly distributed random numbers. + +%% uniform/0: returns a random float X where 0.0 < X < 1.0, +%% updating the state in the process dictionary. + +-spec uniform() -> float(). +uniform() -> + {X, Seed} = uniform_s(seed_get()), + _ = seed_put(Seed), + X. + +%% uniform/1: given an integer N >= 1, +%% uniform/1 returns a random integer X where 1 =< X =< N, +%% updating the state in the process dictionary. + +-spec uniform(N :: pos_integer()) -> pos_integer(). +uniform(N) -> + {X, Seed} = uniform_s(N, seed_get()), + _ = seed_put(Seed), + X. + +%% uniform_s/1: given a state, uniform_s/1 +%% returns a random float X where 0.0 < X < 1.0, +%% and a new state. + +-spec uniform_s(state()) -> {float(), NewS :: state()}. +uniform_s(State = {#{uniform:=Uniform}, _}) -> + Uniform(State). + +%% uniform_s/2: given an integer N >= 1 and a state, uniform_s/2 +%% uniform_s/2 returns a random integer X where 1 =< X =< N, +%% and a new state. + +-spec uniform_s(N::pos_integer(), state()) -> {pos_integer(), NewS::state()}. +uniform_s(N, State = {#{uniform_n:=Uniform, max:=Max}, _}) + when 0 < N, N =< Max -> + Uniform(N, State); +uniform_s(N, State0 = {#{uniform:=Uniform}, _}) + when is_integer(N), 0 < N -> + {F, State} = Uniform(State0), + {trunc(F * N) + 1, State}. + +%% ===================================================================== +%% Internal functions + +-define(UINT21MASK, 16#00000000001fffff). +-define(UINT32MASK, 16#00000000ffffffff). +-define(UINT33MASK, 16#00000001ffffffff). +-define(UINT39MASK, 16#0000007fffffffff). +-define(UINT58MASK, 16#03ffffffffffffff). +-define(UINT64MASK, 16#ffffffffffffffff). + +-type uint64() :: 0..16#ffffffffffffffff. +-type uint58() :: 0..16#03ffffffffffffff. + +-spec seed_put(state()) -> undefined | state(). +seed_put(Seed) -> + put(?SEED_DICT, Seed). + +seed_get() -> + case get(?SEED_DICT) of + undefined -> seed(?DEFAULT_ALG_HANDLER); + Old -> Old % no type checking here + end. + +%% Setup alg record +mk_alg(exs64) -> + {#{type=>exs64, max=>?UINT64MASK, + uniform=>fun exs64_uniform/1, uniform_n=>fun exs64_uniform/2}, + fun exs64_seed/1}; +mk_alg(exsplus) -> + {#{type=>exsplus, max=>?UINT58MASK, + uniform=>fun exsplus_uniform/1, uniform_n=>fun exsplus_uniform/2}, + fun exsplus_seed/1}; +mk_alg(exs1024) -> + {#{type=>exs1024, max=>?UINT64MASK, + uniform=>fun exs1024_uniform/1, uniform_n=>fun exs1024_uniform/2}, + fun exs1024_seed/1}. + +%% ===================================================================== +%% exs64 PRNG: Xorshift64* +%% Algorithm by Sebastiano Vigna +%% Reference URL: http://xorshift.di.unimi.it/ +%% ===================================================================== + +-type exs64_state() :: uint64(). + +exs64_seed({A1, A2, A3}) -> + {V1, _} = exs64_next(((A1 band ?UINT32MASK) * 4294967197 + 1)), + {V2, _} = exs64_next(((A2 band ?UINT32MASK) * 4294967231 + 1)), + {V3, _} = exs64_next(((A3 band ?UINT32MASK) * 4294967279 + 1)), + ((V1 * V2 * V3) rem (?UINT64MASK - 1)) + 1. + +%% Advance xorshift64* state for one step and generate 64bit unsigned integer +-spec exs64_next(exs64_state()) -> {uint64(), exs64_state()}. +exs64_next(R) -> + R1 = R bxor (R bsr 12), + R2 = R1 bxor ((R1 band ?UINT39MASK) bsl 25), + R3 = R2 bxor (R2 bsr 27), + {(R3 * 2685821657736338717) band ?UINT64MASK, R3}. + +exs64_uniform({Alg, R0}) -> + {V, R1} = exs64_next(R0), + {V / 18446744073709551616, {Alg, R1}}. + +exs64_uniform(Max, {Alg, R}) -> + {V, R1} = exs64_next(R), + {(V rem Max) + 1, {Alg, R1}}. + +%% ===================================================================== +%% exsplus PRNG: Xorshift116+ +%% Algorithm by Sebastiano Vigna +%% Reference URL: http://xorshift.di.unimi.it/ +%% 58 bits fits into an immediate on 64bits erlang and is thus much faster. +%% Modification of the original Xorshift128+ algorithm to 116 +%% by Sebastiano Vigna, a lot of thanks for his help and work. +%% ===================================================================== +-type exsplus_state() :: [uint58()|uint58()]. + +exsplus_seed({A1, A2, A3}) -> + {_, R1} = exsplus_next([(((A1 * 4294967197) + 1) band ?UINT58MASK)| + (((A2 * 4294967231) + 1) band ?UINT58MASK)]), + {_, R2} = exsplus_next([(((A3 * 4294967279) + 1) band ?UINT58MASK)| + tl(R1)]), + R2. + +%% Advance xorshift116+ state for one step and generate 58bit unsigned integer +-spec exsplus_next(exsplus_state()) -> {uint58(), exsplus_state()}. +exsplus_next([S1|S0]) -> + %% Note: members s0 and s1 are swapped here + S11 = (S1 bxor (S1 bsl 24)) band ?UINT58MASK, + S12 = S11 bxor S0 bxor (S11 bsr 11) bxor (S0 bsr 41), + {(S0 + S12) band ?UINT58MASK, [S0|S12]}. + +exsplus_uniform({Alg, R0}) -> + {I, R1} = exsplus_next(R0), + {I / (?UINT58MASK+1), {Alg, R1}}. + +exsplus_uniform(Max, {Alg, R}) -> + {V, R1} = exsplus_next(R), + {(V rem Max) + 1, {Alg, R1}}. + +%% ===================================================================== +%% exs1024 PRNG: Xorshift1024* +%% Algorithm by Sebastiano Vigna +%% Reference URL: http://xorshift.di.unimi.it/ +%% ===================================================================== + +-type exs1024_state() :: {list(uint64()), list(uint64())}. + +exs1024_seed({A1, A2, A3}) -> + B1 = (((A1 band ?UINT21MASK) + 1) * 2097131) band ?UINT21MASK, + B2 = (((A2 band ?UINT21MASK) + 1) * 2097133) band ?UINT21MASK, + B3 = (((A3 band ?UINT21MASK) + 1) * 2097143) band ?UINT21MASK, + {exs1024_gen1024((B1 bsl 43) bor (B2 bsl 22) bor (B3 bsl 1) bor 1), + []}. + +%% Generate a list of 16 64-bit element list +%% of the xorshift64* random sequence +%% from a given 64-bit seed. +%% Note: dependent on exs64_next/1 +-spec exs1024_gen1024(uint64()) -> list(uint64()). +exs1024_gen1024(R) -> + exs1024_gen1024(16, R, []). + +exs1024_gen1024(0, _, L) -> + L; +exs1024_gen1024(N, R, L) -> + {X, R2} = exs64_next(R), + exs1024_gen1024(N - 1, R2, [X|L]). + +%% Calculation of xorshift1024*. +%% exs1024_calc(S0, S1) -> {X, NS1}. +%% X: random number output +-spec exs1024_calc(uint64(), uint64()) -> {uint64(), uint64()}. +exs1024_calc(S0, S1) -> + S11 = S1 bxor ((S1 band ?UINT33MASK) bsl 31), + S12 = S11 bxor (S11 bsr 11), + S01 = S0 bxor (S0 bsr 30), + NS1 = S01 bxor S12, + {(NS1 * 1181783497276652981) band ?UINT64MASK, NS1}. + +%% Advance xorshift1024* state for one step and generate 64bit unsigned integer +-spec exs1024_next(exs1024_state()) -> {uint64(), exs1024_state()}. +exs1024_next({[S0,S1|L3], RL}) -> + {X, NS1} = exs1024_calc(S0, S1), + {X, {[NS1|L3], [S0|RL]}}; +exs1024_next({[H], RL}) -> + NL = [H|lists:reverse(RL)], + exs1024_next({NL, []}). + +exs1024_uniform({Alg, R0}) -> + {V, R1} = exs1024_next(R0), + {V / 18446744073709551616, {Alg, R1}}. + +exs1024_uniform(Max, {Alg, R}) -> + {V, R1} = exs1024_next(R), + {(V rem Max) + 1, {Alg, R1}}. diff --git a/lib/stdlib/src/stdlib.app.src b/lib/stdlib/src/stdlib.app.src index a435d683a5..68c7ec07e3 100644 --- a/lib/stdlib/src/stdlib.app.src +++ b/lib/stdlib/src/stdlib.app.src @@ -83,6 +83,7 @@ qlc, qlc_pt, queue, + rand, random, re, sets, diff --git a/lib/stdlib/test/Makefile b/lib/stdlib/test/Makefile index a271229c59..a1c1ce7c70 100644 --- a/lib/stdlib/test/Makefile +++ b/lib/stdlib/test/Makefile @@ -53,6 +53,7 @@ MODULES= \ proc_lib_SUITE \ qlc_SUITE \ queue_SUITE \ + rand_SUITE \ random_SUITE \ re_SUITE \ run_pcre_tests \ diff --git a/lib/stdlib/test/rand_SUITE.erl b/lib/stdlib/test/rand_SUITE.erl new file mode 100644 index 0000000000..70d219ddaf --- /dev/null +++ b/lib/stdlib/test/rand_SUITE.erl @@ -0,0 +1,496 @@ +%% +%% %CopyrightBegin% +%% +%% Copyright Ericsson AB 2000-2011. All Rights Reserved. +%% +%% The contents of this file are subject to the Erlang Public License, +%% Version 1.1, (the "License"); you may not use this file except in +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved online at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% %CopyrightEnd% + +-module(rand_SUITE). +-export([all/0, suite/0,groups/0, + init_per_suite/1, end_per_suite/1, + init_per_group/2,end_per_group/2, + init_per_testcase/2, end_per_testcase/2 + ]). + +-export([interval_int/1, interval_float/1, seed/1, + api_eq/1, reference/1, basic_stats/1, + plugin/1, measure/1 + ]). + +-export([test/0, gen/1]). + +-include_lib("test_server/include/test_server.hrl"). + +% Default timetrap timeout (set in init_per_testcase). +-define(default_timeout, ?t:minutes(1)). +-define(LOOP, 1000000). + +init_per_testcase(_Case, Config) -> + Dog = ?t:timetrap(?default_timeout), + [{watchdog, Dog} | Config]. +end_per_testcase(_Case, Config) -> + Dog = ?config(watchdog, Config), + test_server:timetrap_cancel(Dog), + ok. + +suite() -> [{ct_hooks,[ts_install_cth]}]. + +all() -> + [seed, interval_int, interval_float, + api_eq, + reference, + basic_stats, + plugin, measure + ]. + +groups() -> []. + +init_per_suite(Config) -> Config. +end_per_suite(_Config) -> ok. + +init_per_group(_GroupName, Config) -> Config. +end_per_group(_GroupName, Config) -> Config. + +%% A simple helper to test without test_server during dev +test() -> + Tests = all(), + lists:foreach(fun(Test) -> + try + ok = ?MODULE:Test([]), + io:format("~p: ok~n", [Test]) + catch _:Reason -> + io:format("Failed: ~p: ~p ~p~n", + [Test, Reason, erlang:get_stacktrace()]) + end + end, Tests). + +algs() -> + [exs64, exsplus, exs1024]. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +seed(doc) -> + ["Test that seed and seed_s and export_seed/0 is working."]; +seed(suite) -> + []; +seed(Config) when is_list(Config) -> + Algs = algs(), + Test = fun(Alg) -> + try seed_1(Alg) + catch _:Reason -> + test_server:fail({Alg, Reason, erlang:get_stacktrace()}) + end + end, + [Test(Alg) || Alg <- Algs], + ok. + +seed_1(Alg) -> + %% Check that uniform seeds automatically, + _ = rand:uniform(), + S00 = get(rand_seed), + erase(), + _ = rand:uniform(), + false = S00 =:= get(rand_seed), %% hopefully + + %% Choosing algo and seed + S0 = rand:seed(Alg, {0, 0, 0}), + %% Check that (documented?) process_dict variable is correct + S0 = get(rand_seed), + S0 = rand:seed_s(Alg, {0, 0, 0}), + %% Check that process_dict should not be used for seed_s functionality + _ = rand:seed_s(Alg, {1, 0, 0}), + S0 = get(rand_seed), + %% Test export + ES0 = rand:export_seed(), + ES0 = rand:export_seed_s(S0), + S0 = rand:seed(ES0), + S0 = rand:seed_s(ES0), + %% seed/1 calls should be unique + S1 = rand:seed(Alg), + false = (S1 =:= rand:seed_s(Alg)), + %% Negative integers works + _ = rand:seed_s(Alg, {-1,-1,-1}), + + %% Other term do not work + {'EXIT', _} = (catch rand:seed_s(foobar, os:timestamp())), + {'EXIT', _} = (catch rand:seed_s(Alg, {asd, 1, 1})), + {'EXIT', _} = (catch rand:seed_s(Alg, {0, 234.1234, 1})), + {'EXIT', _} = (catch rand:seed_s(Alg, {0, 234, [1, 123, 123]})), + ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +api_eq(doc) -> + ["Check that both api's are consistent with each other."]; +api_eq(suite) -> + []; +api_eq(_Config) -> + Algs = algs(), + Small = fun(Alg) -> + Seed = rand:seed(Alg), + api_eq_1(Seed) + end, + _ = [Small(Alg) || Alg <- Algs], + ok. + +api_eq_1(S00) -> + Check = fun(_, Seed) -> + {V0, S0} = rand:uniform_s(Seed), + V0 = rand:uniform(), + {V1, S1} = rand:uniform_s(1000000, S0), + V1 = rand:uniform(1000000), + S1 + end, + S1 = lists:foldl(Check, S00, lists:seq(1, 200)), + S1 = get(rand_seed), + Exported = rand:export_seed(), + Exported = rand:export_seed_s(S1), + {V0, S2} = rand:uniform_s(S1), + V0 = rand:uniform(), + + S3 = lists:foldl(Check, S2, lists:seq(1, 200)), + S1 = rand:seed(Exported), + S1 = rand:seed_s(Exported), + + S4 = lists:foldl(Check, S1, lists:seq(1, 200)), + + %% Verify that we do not have loops + false = S1 =:= S2, + false = S2 =:= S3, + false = S3 =:= S4, + + S1 = rand:seed(Exported), + S4 = lists:foldl(Check, S1, lists:seq(1, 200)), + ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +interval_int(doc) -> + ["Check that uniform/1 returns values within the proper interval."]; +interval_int(suite) -> + []; +interval_int(Config) when is_list(Config) -> + Algs = algs(), + Small = fun(Alg) -> + _ = rand:seed(Alg), + Max = interval_int_1(100000, 7, 0), + Max =:= 7 orelse exit({7, Alg, Max}) + end, + _ = [Small(Alg) || Alg <- Algs], + %% Test large integers + Large = fun(Alg) -> + _ = rand:seed(Alg), + Max = interval_int_1(100000, 1 bsl 128, 0), + Max > 1 bsl 64 orelse exit({large, Alg, Max}) + end, + [Large(Alg) || Alg <- Algs], + ok. + +interval_int_1(0, _, Max) -> Max; +interval_int_1(N, Top, Max) -> + X = rand:uniform(Top), + if + 0 < X, X =< Top -> + ok; + true -> + io:format("X=~p Top=~p 0<~p<~p~n", [X,Top,X,Top]), + exit({X, rand:export_seed()}) + end, + interval_int_1(N-1, Top, max(X, Max)). + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +interval_float(doc) -> + ["Check that uniform/0 returns values within the proper interval."]; +interval_float(suite) -> + []; +interval_float(Config) when is_list(Config) -> + Algs = algs(), + Test = fun(Alg) -> + _ = rand:seed(Alg), + interval_float_1(100000) + end, + [Test(Alg) || Alg <- Algs], + ok. + +interval_float_1(0) -> ok; +interval_float_1(N) -> + X = rand:uniform(), + if + 0.0 < X, X < 1.0 -> + ok; + true -> + io:format("X=~p 0<~p<1.0~n", [X,X]), + exit({X, rand:export_seed()}) + end, + interval_float_1(N-1). + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +reference(doc) -> ["Check if exs64 algorithm generates the proper sequence."]; +reference(suite) -> []; +reference(Config) when is_list(Config) -> + [reference_1(Alg) || Alg <- algs()], + ok. + +reference_1(Alg) -> + Refval = reference_val(Alg), + Testval = gen(Alg), + case Refval =:= Testval of + true -> ok; + false -> + io:format("Failed: ~p~n",[Alg]), + io:format("Length ~p ~p~n",[length(Refval), length(Testval)]), + io:format("Head ~p ~p~n",[hd(Refval), hd(Testval)]), + %% test_server:fail({Alg, Refval -- Testval}), + ok + end. + +gen(Algo) -> + Seed = case Algo of + exsplus -> %% Printed with orig 'C' code and this seed + rand:seed_s({exsplus, [12345678|12345678]}); + exs64 -> %% Printed with orig 'C' code and this seed + rand:seed_s({exs64, 12345678}); + exs1024 -> %% Printed with orig 'C' code and this seed + rand:seed_s({exs1024, {lists:duplicate(16, 12345678), []}}); + _ -> + rand:seed(Algo, {100, 200, 300}) + end, + gen(?LOOP, Seed, []). + +gen(N, State0 = {#{max:=Max}, _}, Acc) when N > 0 -> + {Random, State} = rand:uniform_s(Max, State0), + case N rem (?LOOP div 100) of + 0 -> gen(N-1, State, [Random|Acc]); + _ -> gen(N-1, State, Acc) + end; +gen(_, _, Acc) -> lists:reverse(Acc). + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% This just tests the basics so we have not made any serious errors +%% when making the conversion from the original algorithms. +%% The algorithms must have good properties to begin with +%% + +basic_stats(doc) -> ["Check that the algorithms generate sound values."]; +basic_stats(suite) -> []; +basic_stats(Config) when is_list(Config) -> + [basic_stats_1(?LOOP, rand:seed_s(Alg), 0.0, array:new([{default, 0}])) + || Alg <- algs()], + [basic_stats_2(?LOOP, rand:seed_s(Alg), 0, array:new([{default, 0}])) + || Alg <- algs()], + ok. + +basic_stats_1(N, S0, Sum, A0) when N > 0 -> + {X,S} = rand:uniform_s(S0), + I = trunc(X*100), + A = array:set(I, 1+array:get(I,A0), A0), + basic_stats_1(N-1, S, Sum+X, A); +basic_stats_1(0, {#{type:=Alg}, _}, Sum, A) -> + AverN = Sum / ?LOOP, + io:format("~.10w: Average: ~.4f~n", [Alg, AverN]), + Counters = array:to_list(A), + Min = lists:min(Counters), + Max = lists:max(Counters), + io:format("~.10w: Min: ~p Max: ~p~n", [Alg, Min, Max]), + + %% Verify that the basic statistics are ok + %% be gentle we don't want to see to many failing tests + abs(0.5 - AverN) < 0.005 orelse test_server:fail({average, Alg, AverN}), + abs(?LOOP div 100 - Min) < 1000 orelse test_server:fail({min, Alg, Min}), + abs(?LOOP div 100 - Max) < 1000 orelse test_server:fail({max, Alg, Max}), + ok. + +basic_stats_2(N, S0, Sum, A0) when N > 0 -> + {X,S} = rand:uniform_s(100, S0), + A = array:set(X-1, 1+array:get(X-1,A0), A0), + basic_stats_2(N-1, S, Sum+X, A); +basic_stats_2(0, {#{type:=Alg}, _}, Sum, A) -> + AverN = Sum / ?LOOP, + io:format("~.10w: Average: ~.4f~n", [Alg, AverN]), + Counters = tl(array:to_list(A)), + Min = lists:min(Counters), + Max = lists:max(Counters), + io:format("~.10w: Min: ~p Max: ~p~n", [Alg, Min, Max]), + + %% Verify that the basic statistics are ok + %% be gentle we don't want to see to many failing tests + abs(50.5 - AverN) < 0.5 orelse test_server:fail({average, Alg, AverN}), + abs(?LOOP div 100 - Min) < 1000 orelse test_server:fail({min, Alg, Min}), + abs(?LOOP div 100 - Max) < 1000 orelse test_server:fail({max, Alg, Max}), + ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +plugin(doc) -> ["Test that the user can write algorithms"]; +plugin(suite) -> []; +plugin(Config) when is_list(Config) -> + _ = lists:foldl(fun(_, S0) -> + {V1, S1} = rand:uniform_s(10000, S0), + true = is_integer(V1), + {V2, S2} = rand:uniform_s(S1), + true = is_float(V2), + S2 + end, crypto_seed(), lists:seq(1, 200)), + ok. + +%% Test implementation +crypto_seed() -> + {#{type=>crypto, + uniform=>fun crypto_uniform/1, + uniform_n=>fun crypto_uniform_n/2}, + <<>>}. + + +%% Be fair and create bignums i.e. 64bits otherwise use 58bits +crypto_next(<>) -> + {Num, Bin}; +crypto_next(_) -> + crypto_next(crypto:rand_bytes((64 div 8)*100)). + +crypto_uniform({Api, Data0}) -> + {Int, Data} = crypto_next(Data0), + {Int / (1 bsl 64), {Api, Data}}. + +crypto_uniform_n(N, {Api, Data0}) when N < (1 bsl 64) -> + {Int, Data} = crypto_next(Data0), + {(Int rem N)+1, {Api, Data}}; +crypto_uniform_n(N, State0) -> + {F,State} = crypto_uniform(State0), + {trunc(F * N) + 1, State}. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%% Not a test but measures the time characteristics of the different algorithms +measure(Suite) when is_atom(Suite) -> []; +measure(_Config) -> + Algos = [crypto64|algs()], + io:format("RNG integer performance~n",[]), + _ = [measure_1(Algo, fun(State) -> rand:uniform_s(10000, State) end) || Algo <- Algos], + io:format("RNG float performance~n",[]), + _ = [measure_1(Algo, fun(State) -> rand:uniform_s(State) end) || Algo <- Algos], + ok. + +measure_1(Algo, Gen) -> + Parent = self(), + Seed = fun(crypto64) -> crypto_seed(); + (Alg) -> rand:seed_s(Alg) + end, + + Pid = spawn_link(fun() -> + Fun = fun() -> measure_2(?LOOP, Seed(Algo), Gen) end, + {Time, ok} = timer:tc(Fun), + io:format("~.10w: ~pµs~n", [Algo, Time]), + Parent ! {self(), ok}, + normal + end), + receive + {Pid, Msg} -> Msg + end. + +measure_2(N, State0, Fun) when N > 0 -> + case Fun(State0) of + {Random, State} + when is_integer(Random), Random >= 1, Random =< 100000 -> + measure_2(N-1, State, Fun); + {Random, State} when is_float(Random), Random > 0, Random < 1 -> + measure_2(N-1, State, Fun); + Res -> + exit({error, Res, State0}) + end; +measure_2(0, _, _) -> ok. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%% Data +reference_val(exs64) -> + [16#3737ad0c703ff6c3,16#3868a78fe71adbbd,16#1f01b62b4338b605,16#50876a917437965f, + 16#b2edfe32a10e27fc,16#995924551d8ebae1,16#9f1e6b94e94e0b58,16#27ec029eb0e94f8e, + 16#bf654e6df7fe5c,16#b7d5ef7b79be65e3,16#4bdba4d1c159126b,16#a9c816fdc701292c, + 16#a377b6c89d85ac8b,16#7abb5cd0e5847a6,16#62666f1fc00a0a90,16#1edc3c3d255a8113, + 16#dfc764073767f18e,16#381783d577ca4e34,16#49693588c085ddcb,16#da6fcb16dd5163f3, + 16#e2357a703475b1b7,16#aaa84c4924b5985a,16#b8fe07bb2bac1e49,16#23973ac0160ff064, + 16#1afbc7b023f5d618,16#9f510f7b7caa2a0f,16#d5b0a57f7f5f1084,16#d8c49b66c5f99a29, + 16#e920ac3b598b5213,16#1090d7e27e7a7c76,16#81171917168ee74f,16#f08489a3eb6988e, + 16#396260c4f0b2ed46,16#4fd0a6a6caefd5b2,16#423dff07a3b888a,16#12718773ebd99987, + 16#e50991e540807cb,16#8cfa03bbaa6679d6,16#55bdf86dfbb92dbf,16#eb7145378cce74a8, + 16#71856c224c846595,16#20461588dae6e24d,16#c73b3e63ced74bac,16#775b11813dda0c78, + 16#91f358e51068ede0,16#399955ef36766bc2,16#4489ee072e8a38b1,16#ba77759d52321ca0, + 16#14f519eab5c53db8,16#1f754bd08e4f34c4,16#99e25ca29b2fcfeb,16#da11927c0d9837f8, + 16#1eeb0f87009f5a87,16#a7c444d3b0db1089,16#49c7fbf0714849ad,16#4f2b693e7f8265cb, + 16#80e1493cbaa8f256,16#186f345bcac2661e,16#330065ae0c698d26,16#5235ed0432c42e93, + 16#429792e31ddb10bb,16#8769054bb6533cff,16#1ab382483444201f,16#2216368786fc7b9, + 16#1efea1155216da0b,16#782dc868ba595452,16#2b80f6d159617f48,16#407fc35121b2fa1b, + 16#90e8be6e618873d1,16#40ad4ec92a8abf8e,16#34e2890f583f435,16#838c0aef0a5d8427, + 16#ed4238f4bd6cbcfa,16#7feed11f7a8bb9f0,16#2b0636a93e26c89d,16#481ad4bea5180646, + 16#673e5ad861afe1cc,16#298eeb519d69e74d,16#eb1dd06d168c856,16#4770651519ee7ef9, + 16#7456ebf1bcf608f1,16#d6200f6fbd61ce05,16#c0695dfab11ab6aa,16#5bff449249983843, + 16#7aba88471474c9ac,16#d7e9e4a21c989e91,16#c5e02ee67ccb7ce1,16#4ea8a3a912246153, + 16#f2e6db7c9ce4ec43,16#39498a95d46d2470,16#c5294fcb8cce8aa9,16#a918fe444719f3dc, + 16#98225f754762c0c0,16#f0721204f2cb43f5,16#b98e77b099d1f2d1,16#691d6f75aee3386, + 16#860c7b2354ec24fd,16#33e007bd0fbcb609,16#7170ae9c20fb3d0,16#31d46938fe383a60]; + +reference_val(exs1024) -> + [16#9c61311d0d4a01fd,16#ce963ef5803b703e,16#545dcffb7b644e1a,16#edd56576a8d778d5, + 16#16bee799783c6b45,16#336f0b3caeb417fa,16#29291b8be26dedfa,16#1efed996d2e1b1a8, + 16#c5c04757bd2dadf9,16#11aa6d194009c616,16#ab2b3e82bdb38a91,16#5011ee46fd2609eb, + 16#766db7e5b701a9bb,16#d42cb2632c419f35,16#107c6a2667bf8557,16#3ffbf922cb306967, + 16#1e71e3d024ac5131,16#6fdb368ec67a5f06,16#b0d8e72e7aa6d1c1,16#e5705a02dae89e3b, + 16#9c24eb68c086a1d3,16#418de330f55f71f0,16#2917ddeb278bc8d2,16#aeba7fba67208f39, + 16#10ceaf40f6af1d8d,16#47a6d06811d33132,16#603a661d6caf720a,16#a28bd0c9bcdacb3c, + 16#f44754f006909762,16#6e25e8e67ccc43bc,16#174378ce374a549e,16#b5598ae9f57c4e50, + 16#ca85807fbcd51dd,16#1816e58d6c3cc32a,16#1b4d630d3c8e96a6,16#c19b1e92b4efc5bd, + 16#665597b20ddd721a,16#fdab4eb21b75c0ae,16#86a612dcfea0756c,16#8fc2da192f9a55f0, + 16#d7c954eb1af31b5,16#6f5ee45b1b80101b,16#ebe8ea4e5a67cbf5,16#1cb952026b4c1400, + 16#44e62caffe7452c0,16#b591d8f3e6d7cbcf,16#250303f8d77b6f81,16#8ef2199aae4c9b8d, + 16#a16baa37a14d7b89,16#c006e4d2b2da158b,16#e6ec7abd54c93b31,16#e6b0d79ae2ab6fa7, + 16#93e4b30e4ab7d4cd,16#42a01b6a4ef63033,16#9ab1e94fe94976e,16#426644e1de302a1f, + 16#8e58569192200139,16#744f014a090107c1,16#15d056801d467c6c,16#51bdad3a8c30225f, + 16#abfc61fb3104bd45,16#c610607122272df7,16#905e67c63116ebfc,16#1e4fd5f443bdc18, + 16#1945d1745bc55a4c,16#f7cd2b18989595bb,16#f0d273b2c646a038,16#ee9a6fdc6fd5d734, + 16#541a518bdb700518,16#6e67ab9a65361d76,16#bcfadc9bfe5b2e06,16#69fa334cf3c11496, + 16#9657df3e0395b631,16#fc0d0442160108ec,16#2ee538da7b1f7209,16#8b20c9fae50a5a9e, + 16#a971a4b5c2b3b6a,16#ff6241e32489438e,16#8fd6433f45255777,16#6e6c82f10818b0dc, + 16#59a8fad3f6af616b,16#7eac34f43f12221c,16#6e429ec2951723ec,16#9a65179767a45c37, + 16#a5f8127d1e6fdf35,16#932c50bc633d8d5c,16#f3bbea4e7ebecb8,16#efc3a2bbf6a8674, + 16#451644a99971cb6,16#cf70776d652c150d,16#c1fe0dcb87a25403,16#9523417132b2452e, + 16#8f98bc30d06b980e,16#bb4b288ecb8daa9a,16#59e54beb32f78045,16#f9ab1562456b9d66, + 16#6435f4130304a793,16#b4bb94c2002e1849,16#49a86d1e4bade982,16#457d63d60ed52b95]; + +reference_val(exsplus) -> + [16#bc76c2e638db,16#15ede2ebb16c9fb,16#185ee2c27d6b88d,16#15d5ee9feafc3a5, + 16#1862e91dfce3e6b,16#2c9744b0fb69e46,16#78b21bc01cef6b,16#2d16a2fae6c76ba, + 16#13dfccb8ff86bce,16#1d9474c59e23f4d,16#d2f67dcd7f0dd6,16#2b6d489d51a0725, + 16#1fa52ef484861d8,16#1ae9e2a38f966d4,16#2264ab1e193acca,16#23bbca085039a05, + 16#2b6eea06a0af0e1,16#3ad47fa8866ea20,16#1ec2802d612d855,16#36c1982b134d50, + 16#296b6a23f5b75e0,16#c5eeb600a9875c,16#2a3fd51d735f9d4,16#56fafa3593a070, + 16#13e9d416ec0423e,16#28101a91b23e9dc,16#32e561eb55ce15a,16#94a7dbba66fe4a, + 16#2e1845043bcec1f,16#235f7513a1b5146,16#e37af1bf2d63cb,16#2048033824a1639, + 16#c255c750995f7,16#2c7542058e89ee3,16#204dfeefbdb62ba,16#f5a936ec63dd66, + 16#33b3b7dbbbd8b90,16#c4f0f79026ffe9,16#20ffee2d37aca13,16#2274f931716be2c, + 16#29b883902ba9df1,16#1a838cd5312717f,16#2edfc49ff3dc1d6,16#418145cbec84c2, + 16#d2d8f1a17d49f,16#d41637bfa4cc6f,16#24437e03a0f5df8,16#3d1d87919b94a90, + 16#20d6997b36769b6,16#16f9d7855cd87ca,16#821ef7e2a062a3,16#2c4d11dc4a2da70, + 16#24a3b27f56ed26b,16#144b23c8b97387a,16#34a2ced56930d12,16#21cc0544113a017, + 16#3e780771f634fb2,16#146c259c02e7e18,16#1d99e4cfad0ef1,16#fdf3dabefc6b3a, + 16#7d0806e4d12dfb,16#3e3ae3580532eae,16#2456544200fbd86,16#f83aad4e88db85, + 16#37c134779463b4d,16#21a20bf64b6e735,16#1c0585ac88b69f2,16#1b3fcea8dd30e56, + 16#334bc301aefd97,16#37066eb7e80a946,16#15a19a6331b570f,16#35e67fa43c3f7d0, + 16#152a4020145fb80,16#8d55139491dfbe,16#21d9cba585c059d,16#31475f363654635, + 16#2567b17acb7a104,16#39201be3a7681c5,16#6bc675fd26b601,16#334b93232b1b1e3, + 16#357c402cb732c6a,16#362e32efe4db46a,16#8edc7ae3da51e5,16#31573376785eac9, + 16#6c6145ffa1169d,16#18ec2c393d45359,16#1f1a5f256e7130c,16#131cc2f49b8004f, + 16#36f715a249f4ec2,16#1c27629826c50d3,16#914d9a6648726a,16#27f5bf5ce2301e8, + 16#3dd493b8012970f,16#be13bed1e00e5c,16#ceef033b74ae10,16#3da38c6a50abe03, + 16#15cbd1a421c7a8c,16#22794e3ec6ef3b1,16#26154d26e7ea99f,16#3a66681359a6ab6]. -- cgit v1.2.3 From 401bf07f5908137cde206f2f755af83c9a7ff71e Mon Sep 17 00:00:00 2001 From: Dan Gudmundsson Date: Tue, 28 Apr 2015 14:37:33 +0200 Subject: stdlib: Document and add normal distributed random value function It is needed in various tests. It uses the Ziggurat algorithm, which is the fastest that I know. --- lib/stdlib/doc/src/Makefile | 1 + lib/stdlib/doc/src/rand.xml | 246 +++++++++++++++++++++++++++++++ lib/stdlib/doc/src/random.xml | 3 + lib/stdlib/doc/src/ref_man.xml | 1 + lib/stdlib/doc/src/specs.xml | 1 + lib/stdlib/src/rand.erl | 323 ++++++++++++++++++++++++++++++++++++++--- lib/stdlib/test/rand_SUITE.erl | 83 +++++++---- 7 files changed, 615 insertions(+), 43 deletions(-) create mode 100644 lib/stdlib/doc/src/rand.xml (limited to 'lib') diff --git a/lib/stdlib/doc/src/Makefile b/lib/stdlib/doc/src/Makefile index f5d8b2072a..031e60f64e 100644 --- a/lib/stdlib/doc/src/Makefile +++ b/lib/stdlib/doc/src/Makefile @@ -81,6 +81,7 @@ XML_REF3_FILES = \ proplists.xml \ qlc.xml \ queue.xml \ + rand.xml \ random.xml \ re.xml \ sets.xml \ diff --git a/lib/stdlib/doc/src/rand.xml b/lib/stdlib/doc/src/rand.xml new file mode 100644 index 0000000000..178afda5a0 --- /dev/null +++ b/lib/stdlib/doc/src/rand.xml @@ -0,0 +1,246 @@ + + + + +
+ + 2015 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + rand + + + 1 + + + + A + rand.xml +
+ rand + Pseudo random number generation + +

Random number generator.

+ +

The module contains several different algorithms and can be + extended with more in the future. The current uniform + distribution algorithms uses the + + scrambled Xorshift algorithms by Sebastiano Vigna and the + normal distribution algorithm uses the + + Ziggurat Method by Marsaglia and Tsang. +

+ +

The implemented algorithms are:

+ + exsplus Xorshift116+, 58 bits precision and period of 2^116-1. + exs64 Xorshift64*, 64 bits precision and a period of 2^64-1. + exs1024 Xorshift1024*, 64 bits precision and a period of 2^1024-1. + + +

The current default algorithm is exsplus. The default + may change in future. If a specific algorithm is required make + sure to always use seed/1 + to initialize the state. +

+ +

Every time a random number is requested, a state is used to + calculate it and a new state produced. The state can either be + implicit or it can be an explicit argument and return value. +

+ +

The functions with implicit state use the process dictionary + variable rand_seed to remember the current state.

+ +

If a process calls uniform/0 or + uniform/1 without + setting a seed first, seed/1 + is called automatically with the default algorithm and creates a + non-constant seed.

+ +

The functions with explicit state never use the process + dictionary.

+ +

Examples:

+ 
+      %% Simple usage. Creates and seeds the default algorithm
+      %% with a non-constant seed if not already done.
+      R0 = rand:uniform(),
+      R1 = rand:uniform(),
+
+      %% Use a given algorithm.
+      _ = rand:seed(exs1024),
+      R2 = rand:uniform(),
+
+      %% Use a given algorithm with a constant seed.
+      _ = rand:seed(exs1024, {123, 123534, 345345}),
+      R3 = rand:uniform(),
+
+      %% Use the functional api with non-constant seed.
+      S0 = rand:seed_s(exsplus),
+      {R4, S1} = rand:uniform_s(S0),
+
+      %% Create a standard normal deviate.
+      {SND0, S2} = rand:normal_s(S1),
+
+ +

This random number generator is not cryptographically + strong. If a strong cryptographic random number generator is + needed, use one of functions in the + crypto + module, for example crypto:rand_bytes/1.

 + + + + + + + + +

Algorithm dependent state.

 + + + + +

Algorithm dependent state which can be printed or saved to file.

 + + + + + + + Seed random number generator + + +

Seeds random number generation with the given algorithm and time dependent + data if AlgOrExpState is an algorithm.

+

Otherwise recreates the exported seed in the process + dictionary, and returns the state. + See also: export_seed/0.

+ + + + + Seed random number generator + +

Seeds random number generation with the given algorithm and time dependent + data if AlgOrExpState is an algorithm.

+

Otherwise recreates the exported seed and returns the state. + See also: export_seed/0.

+ + + + + Seed the random number generation + +

Seeds random number generation with the given algorithm and + integers in the process dictionary and returns + the state.

+ + + + + Seed the random number generation + +

Seeds random number generation with the given algorithm and + integers and returns the state.

+ + + + + + Export the random number generation state + +

Returns the random number state in an external format. + To be used with seed/1.

+ + + + + + Export the random number generation state + +

Returns the random number generator state in an external format. + To be used with seed/1.

+ + + + + + Return a random float + + +

Returns a random float uniformly distributed in the value + range 0.0 < X < 1.0 and + updates the state in the process dictionary.

+ + + + + Return a random float + +

Given a state, uniform_s/1 returns a random float + uniformly distributed in the value range 0.0 < + X < 1.0 and a new state.

+ + + + + + Return a random integer + + +

Given an integer N >= 1, + uniform/1 returns a random integer uniformly + distributed in the value range + 1 <= X <= N and + updates the state in the process dictionary.

+ + + + + Return a random integer + +

Given an integer N >= 1 and a state, + uniform_s/2 returns a random integer uniformly + distributed in the value range 1 <= X <= + N and a new state.

+ + + + + + Return a standard normal distributed random float + +

Returns a standard normal deviate float (that is, the mean + is 0 and the standard deviation is 1) and updates the state in + the process dictionary.

+ + + + + Return a standard normal distributed random float + +

Given a state, normal_s/1 returns a standard normal + deviate float (that is, the mean is 0 and the standard + deviation is 1) and a new state.

+ + + + + diff --git a/lib/stdlib/doc/src/random.xml b/lib/stdlib/doc/src/random.xml index 2cc621ffc3..e475cda23d 100644 --- a/lib/stdlib/doc/src/random.xml +++ b/lib/stdlib/doc/src/random.xml @@ -48,6 +48,9 @@

It should be noted that this random number generator is not cryptographically strong. If a strong cryptographic random number generator is needed for example crypto:rand_bytes/1 could be used instead.

+

The new and improved rand module should be used + instead of this module.

 diff --git a/lib/stdlib/doc/src/ref_man.xml b/lib/stdlib/doc/src/ref_man.xml index ea4009dc3e..459fc8c8ed 100644 --- a/lib/stdlib/doc/src/ref_man.xml +++ b/lib/stdlib/doc/src/ref_man.xml @@ -78,6 +78,7 @@ + diff --git a/lib/stdlib/doc/src/specs.xml b/lib/stdlib/doc/src/specs.xml index fd77b52da6..f12e00b263 100644 --- a/lib/stdlib/doc/src/specs.xml +++ b/lib/stdlib/doc/src/specs.xml @@ -44,6 +44,7 @@ + diff --git a/lib/stdlib/src/rand.erl b/lib/stdlib/src/rand.erl index 0cafb35dd8..6a805eb69e 100644 --- a/lib/stdlib/src/rand.erl +++ b/lib/stdlib/src/rand.erl @@ -25,10 +25,13 @@ -export([seed_s/1, seed_s/2, seed/1, seed/2, export_seed/0, export_seed_s/1, - uniform/0, uniform/1, uniform_s/1, uniform_s/2]). + uniform/0, uniform/1, uniform_s/1, uniform_s/2, + normal/0, normal_s/1 + ]). -compile({inline, [exs64_next/1, exsplus_next/1, - exs1024_next/1, exs1024_calc/2]}). + exs1024_next/1, exs1024_calc/2, + get_52/1, normal_kiwi/1]}). -define(DEFAULT_ALG_HANDLER, exsplus). -define(SEED_DICT, rand_seed). @@ -38,31 +41,33 @@ %% ===================================================================== %% This depends on the algorithm handler function --opaque alg_seed() :: exs64_state() | exsplus_state() | exs1024_state(). +-type alg_seed() :: exs64_state() | exsplus_state() | exs1024_state(). %% This is the algorithm handler function within this module -type alg_handler() :: #{type => alg(), max => integer(), + next => fun(), uniform => fun(), uniform_n => fun()}. %% Internal state --type state() :: {alg_handler(), alg_seed()}. +-opaque state() :: {alg_handler(), alg_seed()}. -type alg() :: exs64 | exsplus | exs1024. --export_type([alg/0, alg_handler/0, state/0, alg_seed/0]). +-opaque export_state() :: {alg(), alg_seed()}. +-export_type([alg/0, state/0, export_state/0]). %% ===================================================================== %% API %% ===================================================================== %% Return algorithm and seed so that RNG state can be recreated with seed/1 --spec export_seed() -> undefined | {alg(), alg_seed()}. +-spec export_seed() -> undefined | export_state(). export_seed() -> case seed_get() of {#{type:=Alg}, Seed} -> {Alg, Seed}; _ -> undefined end. --spec export_seed_s(state()) -> {alg(), alg_seed()}. +-spec export_seed_s(state()) -> export_state(). export_seed_s({#{type:=Alg}, Seed}) -> {Alg, Seed}. %% seed(Alg) seeds RNG with runtime dependent values @@ -71,13 +76,13 @@ export_seed_s({#{type:=Alg}, Seed}) -> {Alg, Seed}. %% seed({Alg,Seed}) setup RNG with a previously exported seed %% and return the NEW state --spec seed(alg() | {alg(), alg_seed()}) -> state(). +-spec seed(AlgOrExpState::alg() | export_state()) -> state(). seed(Alg) -> R = seed_s(Alg), _ = seed_put(R), R. --spec seed_s(alg() | {alg(), alg_seed()}) -> state(). +-spec seed_s(AlgOrExpState::alg() | export_state()) -> state(). seed_s(Alg) when is_atom(Alg) -> seed_s(Alg, {erlang:phash2([{node(),self()}]), erlang:system_time(), @@ -107,7 +112,7 @@ seed_s(Alg0, S0 = {_, _, _}) -> %% uniform/0: returns a random float X where 0.0 < X < 1.0, %% updating the state in the process dictionary. --spec uniform() -> float(). +-spec uniform() -> X::float(). uniform() -> {X, Seed} = uniform_s(seed_get()), _ = seed_put(Seed), @@ -117,7 +122,7 @@ uniform() -> %% uniform/1 returns a random integer X where 1 =< X =< N, %% updating the state in the process dictionary. --spec uniform(N :: pos_integer()) -> pos_integer(). +-spec uniform(N :: pos_integer()) -> X::pos_integer(). uniform(N) -> {X, Seed} = uniform_s(N, seed_get()), _ = seed_put(Seed), @@ -127,7 +132,7 @@ uniform(N) -> %% returns a random float X where 0.0 < X < 1.0, %% and a new state. --spec uniform_s(state()) -> {float(), NewS :: state()}. +-spec uniform_s(state()) -> {X::float(), NewS :: state()}. uniform_s(State = {#{uniform:=Uniform}, _}) -> Uniform(State). @@ -135,7 +140,7 @@ uniform_s(State = {#{uniform:=Uniform}, _}) -> %% uniform_s/2 returns a random integer X where 1 =< X =< N, %% and a new state. --spec uniform_s(N::pos_integer(), state()) -> {pos_integer(), NewS::state()}. +-spec uniform_s(N::pos_integer(), state()) -> {X::pos_integer(), NewS::state()}. uniform_s(N, State = {#{uniform_n:=Uniform, max:=Max}, _}) when 0 < N, N =< Max -> Uniform(N, State); @@ -144,6 +149,35 @@ uniform_s(N, State0 = {#{uniform:=Uniform}, _}) {F, State} = Uniform(State0), {trunc(F * N) + 1, State}. +%% normal/0: returns a random float with standard normal distribution +%% updating the state in the process dictionary. + +-spec normal() -> float(). +normal() -> + {X, Seed} = normal_s(seed_get()), + _ = seed_put(Seed), + X. + +%% normal_s/1: returns a random float with standard normal distribution +%% The Ziggurat Method for generating random variables - Marsaglia and Tsang +%% Paper and reference code: http://www.jstatsoft.org/v05/i08/ + +-spec normal_s(state()) -> {float(), NewS :: state()}. +normal_s(State0) -> + {Sign, R, State} = get_52(State0), + Idx = R band 16#FF, + Idx1 = Idx+1, + {Ki, Wi} = normal_kiwi(Idx1), + X = R * Wi, + case R < Ki of + %% Fast path 95% of the time + true when Sign =:= 0 -> {X, State}; + true -> {-X, State}; + %% Slow path + false when Sign =:= 0 -> normal_s(Idx, Sign, X, State); + false -> normal_s(Idx, Sign, -X, State) + end. + %% ===================================================================== %% Internal functions @@ -169,15 +203,15 @@ seed_get() -> %% Setup alg record mk_alg(exs64) -> - {#{type=>exs64, max=>?UINT64MASK, + {#{type=>exs64, max=>?UINT64MASK, next=>fun exs64_next/1, uniform=>fun exs64_uniform/1, uniform_n=>fun exs64_uniform/2}, fun exs64_seed/1}; mk_alg(exsplus) -> - {#{type=>exsplus, max=>?UINT58MASK, + {#{type=>exsplus, max=>?UINT58MASK, next=>fun exsplus_next/1, uniform=>fun exsplus_uniform/1, uniform_n=>fun exsplus_uniform/2}, fun exsplus_seed/1}; mk_alg(exs1024) -> - {#{type=>exs1024, max=>?UINT64MASK, + {#{type=>exs1024, max=>?UINT64MASK, next=>fun exs1024_next/1, uniform=>fun exs1024_uniform/1, uniform_n=>fun exs1024_uniform/2}, fun exs1024_seed/1}. @@ -219,7 +253,7 @@ exs64_uniform(Max, {Alg, R}) -> %% Modification of the original Xorshift128+ algorithm to 116 %% by Sebastiano Vigna, a lot of thanks for his help and work. %% ===================================================================== --type exsplus_state() :: [uint58()|uint58()]. +-type exsplus_state() :: nonempty_improper_list(uint58(), uint58()). exsplus_seed({A1, A2, A3}) -> {_, R1} = exsplus_next([(((A1 * 4294967197) + 1) band ?UINT58MASK)| @@ -300,3 +334,258 @@ exs1024_uniform({Alg, R0}) -> exs1024_uniform(Max, {Alg, R}) -> {V, R1} = exs1024_next(R), {(V rem Max) + 1, {Alg, R1}}. + +%% ===================================================================== +%% Ziggurat cont +%% ===================================================================== +-define(NOR_R, 3.6541528853610087963519472518). +-define(NOR_INV_R, 1/?NOR_R). + +%% return a {sign, Random51bits, State} +get_52({Alg=#{next:=Next}, S0}) -> + {Int,S1} = Next(S0), + {((1 bsl 51) band Int), Int band ((1 bsl 51)-1), {Alg, S1}}. + +%% Slow path +normal_s(0, Sign, X0, State0) -> + {U0, S1} = uniform_s(State0), + X = -?NOR_INV_R*math:log(U0), + {U1, S2} = uniform_s(S1), + Y = -math:log(U1), + case Y+Y > X*X of + false -> + normal_s(0, Sign, X0, S2); + true when Sign =:= 0 -> + {?NOR_R + X, S2}; + true -> + {-?NOR_R - X, S2} + end; +normal_s(Idx, _Sign, X, State0) -> + Fi2 = normal_fi(Idx+1), + {U0, S1} = uniform_s(State0), + case ((normal_fi(Idx) - Fi2)*U0 + Fi2) < math:exp(-0.5*X*X) of + true -> {X, S1}; + false -> normal_s(S1) + end. + +%% Tables for generating normal_s +%% ki is zipped with wi (slightly faster) +normal_kiwi(Indx) -> + element(Indx, + {{2104047571236786,1.736725412160263e-15}, {0,9.558660351455634e-17}, + {1693657211986787,1.2708704834810623e-16},{1919380038271141,1.4909740962495474e-16}, + {2015384402196343,1.6658733631586268e-16},{2068365869448128,1.8136120810119029e-16}, + {2101878624052573,1.9429720153135588e-16},{2124958784102998,2.0589500628482093e-16}, + {2141808670795147,2.1646860576895422e-16},{2154644611568301,2.2622940392218116e-16}, + {2164744887587275,2.353271891404589e-16},{2172897953696594,2.438723455742877e-16}, + {2179616279372365,2.5194879829274225e-16},{2185247251868649,2.5962199772528103e-16}, + {2190034623107822,2.6694407473648285e-16},{2194154434521197,2.7395729685142446e-16}, + {2197736978774660,2.8069646002484804e-16},{2200880740891961,2.871905890411393e-16}, + {2203661538010620,2.9346417484728883e-16},{2206138681109102,2.9953809336782113e-16}, + {2208359231806599,3.054303000719244e-16},{2210361007258210,3.111563633892157e-16}, + {2212174742388539,3.1672988018581815e-16},{2213825672704646,3.2216280350549905e-16}, + {2215334711002614,3.274657040793975e-16},{2216719334487595,3.326479811684171e-16}, + {2217994262139172,3.377180341735323e-16},{2219171977965032,3.4268340353119356e-16}, + {2220263139538712,3.475508873172976e-16},{2221276900117330,3.523266384600203e-16}, + {2222221164932930,3.5701624633953494e-16},{2223102796829069,3.616248057159834e-16}, + {2223927782546658,3.661569752965354e-16},{2224701368170060,3.7061702777236077e-16}, + {2225428170204312,3.75008892787478e-16},{2226112267248242,3.7933619401549554e-16}, + {2226757276105256,3.836022812967728e-16},{2227366415328399,3.8781025861250247e-16}, + {2227942558554684,3.919630085325768e-16},{2228488279492521,3.9606321366256378e-16}, + {2229005890047222,4.001133755254669e-16},{2229497472775193,4.041158312414333e-16}, + {2229964908627060,4.080727683096045e-16},{2230409900758597,4.119862377480744e-16}, + {2230833995044585,4.1585816580828064e-16},{2231238597816133,4.1969036444740733e-16}, + {2231624991250191,4.234845407152071e-16},{2231994346765928,4.272423051889976e-16}, + {2232347736722750,4.309651795716294e-16},{2232686144665934,4.346546035512876e-16}, + {2233010474325959,4.383119410085457e-16},{2233321557544881,4.4193848564470665e-16}, + {2233620161276071,4.455354660957914e-16},{2233906993781271,4.491040505882875e-16}, + {2234182710130335,4.52645351185714e-16},{2234447917093496,4.561604276690038e-16}, + {2234703177503020,4.596502910884941e-16},{2234949014150181,4.631159070208165e-16}, + {2235185913274316,4.665581985600875e-16},{2235414327692884,4.699780490694195e-16}, + {2235634679614920,4.733763047158324e-16},{2235847363174595,4.767537768090853e-16}, + {2236052746716837,4.8011124396270155e-16},{2236251174862869,4.834494540935008e-16}, + {2236442970379967,4.867691262742209e-16},{2236628435876762,4.900709524522994e-16}, + {2236807855342765,4.933555990465414e-16},{2236981495548562,4.966237084322178e-16}, + {2237149607321147,4.998759003240909e-16},{2237312426707209,5.031127730659319e-16}, + {2237470176035652,5.0633490483427195e-16},{2237623064889403,5.095428547633892e-16}, + {2237771290995388,5.127371639978797e-16},{2237915041040597,5.159183566785736e-16}, + {2238054491421305,5.190869408670343e-16},{2238189808931712,5.222434094134042e-16}, + {2238321151397660,5.253882407719454e-16},{2238448668260432,5.285218997682382e-16}, + {2238572501115169,5.316448383216618e-16},{2238692784207942,5.34757496126473e-16}, + {2238809644895133,5.378603012945235e-16},{2238923204068402,5.409536709623993e-16}, + {2239033576548190,5.440380118655467e-16},{2239140871448443,5.471137208817361e-16}, + {2239245192514958,5.501811855460336e-16},{2239346638439541,5.532407845392784e-16}, + {2239445303151952,5.56292888151909e-16},{2239541276091442,5.593378587248462e-16}, + {2239634642459498,5.623760510690043e-16},{2239725483455293,5.65407812864896e-16}, + {2239813876495186,5.684334850436814e-16},{2239899895417494,5.714534021509204e-16}, + {2239983610673676,5.744678926941961e-16},{2240065089506935,5.774772794756965e-16}, + {2240144396119183,5.804818799107686e-16},{2240221591827230,5.834820063333892e-16}, + {2240296735208969,5.864779662894365e-16},{2240369882240293,5.894700628185872e-16}, + {2240441086423386,5.924585947256134e-16},{2240510398907004,5.95443856841806e-16}, + {2240577868599305,5.984261402772028e-16},{2240643542273726,6.014057326642664e-16}, + {2240707464668391,6.043829183936125e-16},{2240769678579486,6.073579788423606e-16}, + {2240830224948980,6.103311925956439e-16},{2240889142947082,6.133028356617911e-16}, + {2240946470049769,6.162731816816596e-16},{2241002242111691,6.192425021325847e-16}, + {2241056493434746,6.222110665273788e-16},{2241109256832602,6.251791426088e-16}, + {2241160563691400,6.281469965398895e-16},{2241210444026879,6.311148930905604e-16}, + {2241258926538122,6.34083095820806e-16},{2241306038658137,6.370518672608815e-16}, + {2241351806601435,6.400214690888025e-16},{2241396255408788,6.429921623054896e-16}, + {2241439408989313,6.459642074078832e-16},{2241481290160038,6.489378645603397e-16}, + {2241521920683062,6.519133937646159e-16},{2241561321300462,6.548910550287415e-16}, + {2241599511767028,6.578711085350741e-16},{2241636510880960,6.608538148078259e-16}, + {2241672336512612,6.638394348803506e-16},{2241707005631362,6.668282304624746e-16}, + {2241740534330713,6.698204641081558e-16},{2241772937851689,6.728163993837531e-16}, + {2241804230604585,6.758163010371901e-16},{2241834426189161,6.78820435168298e-16}, + {2241863537413311,6.818290694006254e-16},{2241891576310281,6.848424730550038e-16}, + {2241918554154466,6.878609173251664e-16},{2241944481475843,6.908846754557169e-16}, + {2241969368073071,6.939140229227569e-16},{2241993223025298,6.969492376174829e-16}, + {2242016054702685,6.999906000330764e-16},{2242037870775710,7.030383934552151e-16}, + {2242058678223225,7.060929041565482e-16},{2242078483339331,7.091544215954873e-16}, + {2242097291739040,7.122232386196779e-16},{2242115108362774,7.152996516745303e-16}, + {2242131937479672,7.183839610172063e-16},{2242147782689725,7.214764709364707e-16}, + {2242162646924736,7.245774899788387e-16},{2242176532448092,7.276873311814693e-16}, + {2242189440853337,7.308063123122743e-16},{2242201373061537,7.339347561177405e-16}, + {2242212329317416,7.370729905789831e-16},{2242222309184237,7.4022134917658e-16}, + {2242231311537397,7.433801711647648e-16},{2242239334556717,7.465498018555889e-16}, + {2242246375717369,7.497305929136979e-16},{2242252431779415,7.529229026624058e-16}, + {2242257498775893,7.561270964017922e-16},{2242261571999416,7.5934354673958895e-16}, + {2242264645987196,7.625726339356756e-16},{2242266714504453,7.658147462610487e-16}, + {2242267770526109,7.690702803721919e-16},{2242267806216711,7.723396417018299e-16}, + {2242266812908462,7.756232448671174e-16},{2242264781077289,7.789215140963852e-16}, + {2242261700316818,7.822348836756411e-16},{2242257559310145,7.855637984161084e-16}, + {2242252345799276,7.889087141441755e-16},{2242246046552082,7.922700982152271e-16}, + {2242238647326615,7.956484300529366e-16},{2242230132832625,7.99044201715713e-16}, + {2242220486690076,8.024579184921259e-16},{2242209691384458,8.058900995272657e-16}, + {2242197728218684,8.093412784821501e-16},{2242184577261310,8.128120042284501e-16}, + {2242170217290819,8.163028415809877e-16},{2242154625735679,8.198143720706533e-16}, + {2242137778609839,8.23347194760605e-16},{2242119650443327,8.26901927108847e-16}, + {2242100214207556,8.304792058805374e-16},{2242079441234906,8.340796881136629e-16}, + {2242057301132135,8.377040521420222e-16},{2242033761687079,8.413529986798028e-16}, + {2242008788768107,8.450272519724097e-16},{2241982346215682,8.487275610186155e-16}, + {2241954395725356,8.524547008695596e-16},{2241924896721443,8.562094740106233e-16}, + {2241893806220517,8.599927118327665e-16},{2241861078683830,8.638052762005259e-16}, + {2241826665857598,8.676480611245582e-16},{2241790516600041,8.715219945473698e-16}, + {2241752576693881,8.754280402517175e-16},{2241712788642916,8.793671999021043e-16}, + {2241671091451078,8.833405152308408e-16},{2241627420382235,8.873490703813135e-16}, + {2241581706698773,8.913939944224086e-16},{2241533877376767,8.954764640495068e-16}, + {2241483854795281,8.9959770648911e-16},{2241431556397035,9.037590026260118e-16}, + {2241376894317345,9.079616903740068e-16},{2241319774977817,9.122071683134846e-16}, + {2241260098640860,9.164968996219135e-16},{2241197758920538,9.208324163262308e-16}, + {2241132642244704,9.252153239095693e-16},{2241064627262652,9.296473063086417e-16}, + {2240993584191742,9.341301313425265e-16},{2240919374095536,9.38665656618666e-16}, + {2240841848084890,9.432558359676707e-16},{2240760846432232,9.479027264651738e-16}, + {2240676197587784,9.526084961066279e-16},{2240587717084782,9.57375432209745e-16}, + {2240495206318753,9.622059506294838e-16},{2240398451183567,9.671026058823054e-16}, + {2240297220544165,9.720681022901626e-16},{2240191264522612,9.771053062707209e-16}, + {2240080312570155,9.822172599190541e-16},{2239964071293331,9.874071960480671e-16}, + {2239842221996530,9.926785548807976e-16},{2239714417896699,9.980350026183645e-16}, + {2239580280957725,1.003480452143618e-15},{2239439398282193,1.0090190861637457e-15}, + {2239291317986196,1.0146553831467086e-15},{2239135544468203,1.0203941464683124e-15}, + {2238971532964979,1.0262405372613567e-15},{2238798683265269,1.0322001115486456e-15}, + {2238616332424351,1.03827886235154e-15},{2238423746288095,1.044483267600047e-15}, + {2238220109591890,1.0508203448355195e-15},{2238004514345216,1.057297713900989e-15}, + {2237775946143212,1.06392366906768e-15},{2237533267957822,1.0707072623632994e-15}, + {2237275200846753,1.0776584002668106e-15},{2237000300869952,1.0847879564403425e-15}, + {2236706931309099,1.0921079038149563e-15},{2236393229029147,1.0996314701785628e-15}, + {2236057063479501,1.1073733224935752e-15},{2235695986373246,1.1153497865853155e-15}, + {2235307169458859,1.1235791107110833e-15},{2234887326941578,1.1320817840164846e-15}, + {2234432617919447,1.140880924258278e-15},{2233938522519765,1.1500027537839792e-15}, + {2233399683022677,1.159477189144919e-15},{2232809697779198,1.169338578691096e-15}, + {2232160850599817,1.17962663529558e-15},{2231443750584641,1.190387629928289e-15}, + {2230646845562170,1.2016759392543819e-15},{2229755753817986,1.2135560818666897e-15}, + {2228752329126533,1.2261054417450561e-15},{2227613325162504,1.2394179789163251e-15}, + {2226308442121174,1.2536093926602567e-15},{2224797391720399,1.268824481425501e-15}, + {2223025347823832,1.2852479319096109e-15},{2220915633329809,1.3031206634689985e-15}, + {2218357446087030,1.3227655770195326e-15},{2215184158448668,1.3446300925011171e-15}, + {2211132412537369,1.3693606835128518e-15},{2205758503851065,1.397943667277524e-15}, + {2198248265654987,1.4319989869661328e-15},{2186916352102141,1.4744848603597596e-15}, + {2167562552481814,1.5317872741611144e-15},{2125549880839716,1.6227698675312968e-15}}). + +normal_fi(Indx) -> + element(Indx, + {1.0000000000000000e+00,9.7710170126767082e-01,9.5987909180010600e-01, + 9.4519895344229909e-01,9.3206007595922991e-01,9.1999150503934646e-01, + 9.0872644005213032e-01,8.9809592189834297e-01,8.8798466075583282e-01, + 8.7830965580891684e-01,8.6900868803685649e-01,8.6003362119633109e-01, + 8.5134625845867751e-01,8.4291565311220373e-01,8.3471629298688299e-01, + 8.2672683394622093e-01,8.1892919160370192e-01,8.1130787431265572e-01, + 8.0384948317096383e-01,7.9654233042295841e-01,7.8937614356602404e-01, + 7.8234183265480195e-01,7.7543130498118662e-01,7.6863731579848571e-01, + 7.6195334683679483e-01,7.5537350650709567e-01,7.4889244721915638e-01, + 7.4250529634015061e-01,7.3620759812686210e-01,7.2999526456147568e-01, + 7.2386453346862967e-01,7.1781193263072152e-01,7.1183424887824798e-01, + 7.0592850133275376e-01,7.0009191813651117e-01,6.9432191612611627e-01, + 6.8861608300467136e-01,6.8297216164499430e-01,6.7738803621877308e-01, + 6.7186171989708166e-01,6.6639134390874977e-01,6.6097514777666277e-01, + 6.5561147057969693e-01,6.5029874311081637e-01,6.4503548082082196e-01, + 6.3982027745305614e-01,6.3465179928762327e-01,6.2952877992483625e-01, + 6.2445001554702606e-01,6.1941436060583399e-01,6.1442072388891344e-01, + 6.0946806492577310e-01,6.0455539069746733e-01,5.9968175261912482e-01, + 5.9484624376798689e-01,5.9004799633282545e-01,5.8528617926337090e-01, + 5.8055999610079034e-01,5.7586868297235316e-01,5.7121150673525267e-01, + 5.6658776325616389e-01,5.6199677581452390e-01,5.5743789361876550e-01, + 5.5291049042583185e-01,5.4841396325526537e-01,5.4394773119002582e-01, + 5.3951123425695158e-01,5.3510393238045717e-01,5.3072530440366150e-01, + 5.2637484717168403e-01,5.2205207467232140e-01,5.1775651722975591e-01, + 5.1348772074732651e-01,5.0924524599574761e-01,5.0502866794346790e-01, + 5.0083757512614835e-01,4.9667156905248933e-01,4.9253026364386815e-01, + 4.8841328470545758e-01,4.8432026942668288e-01,4.8025086590904642e-01, + 4.7620473271950547e-01,4.7218153846772976e-01,4.6818096140569321e-01, + 4.6420268904817391e-01,4.6024641781284248e-01,4.5631185267871610e-01, + 4.5239870686184824e-01,4.4850670150720273e-01,4.4463556539573912e-01, + 4.4078503466580377e-01,4.3695485254798533e-01,4.3314476911265209e-01, + 4.2935454102944126e-01,4.2558393133802180e-01,4.2183270922949573e-01, + 4.1810064983784795e-01,4.1438753404089090e-01,4.1069314827018799e-01, + 4.0701728432947315e-01,4.0335973922111429e-01,3.9972031498019700e-01, + 3.9609881851583223e-01,3.9249506145931540e-01,3.8890886001878855e-01, + 3.8534003484007706e-01,3.8178841087339344e-01,3.7825381724561896e-01, + 3.7473608713789086e-01,3.7123505766823922e-01,3.6775056977903225e-01, + 3.6428246812900372e-01,3.6083060098964775e-01,3.5739482014578022e-01, + 3.5397498080007656e-01,3.5057094148140588e-01,3.4718256395679348e-01, + 3.4380971314685055e-01,3.4045225704452164e-01,3.3711006663700588e-01, + 3.3378301583071823e-01,3.3047098137916342e-01,3.2717384281360129e-01, + 3.2389148237639104e-01,3.2062378495690530e-01,3.1737063802991350e-01, + 3.1413193159633707e-01,3.1090755812628634e-01,3.0769741250429189e-01, + 3.0450139197664983e-01,3.0131939610080288e-01,2.9815132669668531e-01, + 2.9499708779996164e-01,2.9185658561709499e-01,2.8872972848218270e-01, + 2.8561642681550159e-01,2.8251659308370741e-01,2.7943014176163772e-01, + 2.7635698929566810e-01,2.7329705406857691e-01,2.7025025636587519e-01, + 2.6721651834356114e-01,2.6419576399726080e-01,2.6118791913272082e-01, + 2.5819291133761890e-01,2.5521066995466168e-01,2.5224112605594190e-01, + 2.4928421241852824e-01,2.4633986350126363e-01,2.4340801542275012e-01, + 2.4048860594050039e-01,2.3758157443123795e-01,2.3468686187232990e-01, + 2.3180441082433859e-01,2.2893416541468023e-01,2.2607607132238020e-01, + 2.2323007576391746e-01,2.2039612748015194e-01,2.1757417672433113e-01, + 2.1476417525117358e-01,2.1196607630703015e-01,2.0917983462112499e-01, + 2.0640540639788071e-01,2.0364274931033485e-01,2.0089182249465656e-01, + 1.9815258654577511e-01,1.9542500351413428e-01,1.9270903690358912e-01, + 1.9000465167046496e-01,1.8731181422380025e-01,1.8463049242679927e-01, + 1.8196065559952254e-01,1.7930227452284767e-01,1.7665532144373500e-01, + 1.7401977008183875e-01,1.7139559563750595e-01,1.6878277480121151e-01, + 1.6618128576448205e-01,1.6359110823236570e-01,1.6101222343751107e-01, + 1.5844461415592431e-01,1.5588826472447920e-01,1.5334316106026283e-01, + 1.5080929068184568e-01,1.4828664273257453e-01,1.4577520800599403e-01, + 1.4327497897351341e-01,1.4078594981444470e-01,1.3830811644855071e-01, + 1.3584147657125373e-01,1.3338602969166913e-01,1.3094177717364430e-01, + 1.2850872227999952e-01,1.2608687022018586e-01,1.2367622820159654e-01, + 1.2127680548479021e-01,1.1888861344290998e-01,1.1651166562561080e-01, + 1.1414597782783835e-01,1.1179156816383801e-01,1.0944845714681163e-01, + 1.0711666777468364e-01,1.0479622562248690e-01,1.0248715894193508e-01, + 1.0018949876880981e-01,9.7903279038862284e-02,9.5628536713008819e-02, + 9.3365311912690860e-02,9.1113648066373634e-02,8.8873592068275789e-02, + 8.6645194450557961e-02,8.4428509570353374e-02,8.2223595813202863e-02, + 8.0030515814663056e-02,7.7849336702096039e-02,7.5680130358927067e-02, + 7.3522973713981268e-02,7.1377949058890375e-02,6.9245144397006769e-02, + 6.7124653827788497e-02,6.5016577971242842e-02,6.2921024437758113e-02, + 6.0838108349539864e-02,5.8767952920933758e-02,5.6710690106202902e-02, + 5.4666461324888914e-02,5.2635418276792176e-02,5.0617723860947761e-02, + 4.8613553215868521e-02,4.6623094901930368e-02,4.4646552251294443e-02, + 4.2684144916474431e-02,4.0736110655940933e-02,3.8802707404526113e-02, + 3.6884215688567284e-02,3.4980941461716084e-02,3.3093219458578522e-02, + 3.1221417191920245e-02,2.9365939758133314e-02,2.7527235669603082e-02, + 2.5705804008548896e-02,2.3902203305795882e-02,2.2117062707308864e-02, + 2.0351096230044517e-02,1.8605121275724643e-02,1.6880083152543166e-02, + 1.5177088307935325e-02,1.3497450601739880e-02,1.1842757857907888e-02, + 1.0214971439701471e-02,8.6165827693987316e-03,7.0508754713732268e-03, + 5.5224032992509968e-03,4.0379725933630305e-03,2.6090727461021627e-03, + 1.2602859304985975e-03}). diff --git a/lib/stdlib/test/rand_SUITE.erl b/lib/stdlib/test/rand_SUITE.erl index 70d219ddaf..9a1f37aa75 100644 --- a/lib/stdlib/test/rand_SUITE.erl +++ b/lib/stdlib/test/rand_SUITE.erl @@ -139,6 +139,7 @@ api_eq(_Config) -> Algs = algs(), Small = fun(Alg) -> Seed = rand:seed(Alg), + io:format("Seed ~p~n",[rand:export_seed_s(Seed)]), api_eq_1(Seed) end, _ = [Small(Alg) || Alg <- Algs], @@ -150,28 +151,31 @@ api_eq_1(S00) -> V0 = rand:uniform(), {V1, S1} = rand:uniform_s(1000000, S0), V1 = rand:uniform(1000000), - S1 + {V2, S2} = rand:normal_s(S1), + V2 = rand:normal(), + S2 end, S1 = lists:foldl(Check, S00, lists:seq(1, 200)), S1 = get(rand_seed), - Exported = rand:export_seed(), - Exported = rand:export_seed_s(S1), {V0, S2} = rand:uniform_s(S1), V0 = rand:uniform(), + S2 = get(rand_seed), - S3 = lists:foldl(Check, S2, lists:seq(1, 200)), - S1 = rand:seed(Exported), - S1 = rand:seed_s(Exported), + Exported = rand:export_seed(), + Exported = rand:export_seed_s(S2), - S4 = lists:foldl(Check, S1, lists:seq(1, 200)), + S3 = lists:foldl(Check, S2, lists:seq(1, 200)), + S3 = get(rand_seed), + S4 = lists:foldl(Check, S3, lists:seq(1, 200)), + S4 = get(rand_seed), %% Verify that we do not have loops false = S1 =:= S2, false = S2 =:= S3, false = S3 =:= S4, - S1 = rand:seed(Exported), - S4 = lists:foldl(Check, S1, lists:seq(1, 200)), + S2 = rand:seed(Exported), + S3 = lists:foldl(Check, S2, lists:seq(1, 200)), ok. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -183,14 +187,16 @@ interval_int(suite) -> interval_int(Config) when is_list(Config) -> Algs = algs(), Small = fun(Alg) -> - _ = rand:seed(Alg), + Seed = rand:seed(Alg), + io:format("Seed ~p~n",[rand:export_seed_s(Seed)]), Max = interval_int_1(100000, 7, 0), Max =:= 7 orelse exit({7, Alg, Max}) end, _ = [Small(Alg) || Alg <- Algs], %% Test large integers Large = fun(Alg) -> - _ = rand:seed(Alg), + Seed = rand:seed(Alg), + io:format("Seed ~p~n",[rand:export_seed_s(Seed)]), Max = interval_int_1(100000, 1 bsl 128, 0), Max > 1 bsl 64 orelse exit({large, Alg, Max}) end, @@ -287,18 +293,21 @@ gen(_, _, Acc) -> lists:reverse(Acc). basic_stats(doc) -> ["Check that the algorithms generate sound values."]; basic_stats(suite) -> []; basic_stats(Config) when is_list(Config) -> - [basic_stats_1(?LOOP, rand:seed_s(Alg), 0.0, array:new([{default, 0}])) + io:format("Testing uniform~n",[]), + [basic_uniform_1(?LOOP, rand:seed_s(Alg), 0.0, array:new([{default, 0}])) || Alg <- algs()], - [basic_stats_2(?LOOP, rand:seed_s(Alg), 0, array:new([{default, 0}])) + [basic_uniform_2(?LOOP, rand:seed_s(Alg), 0, array:new([{default, 0}])) || Alg <- algs()], + io:format("Testing normal~n",[]), + [basic_normal_1(?LOOP, rand:seed_s(Alg), 0, 0) || Alg <- algs()], ok. -basic_stats_1(N, S0, Sum, A0) when N > 0 -> +basic_uniform_1(N, S0, Sum, A0) when N > 0 -> {X,S} = rand:uniform_s(S0), I = trunc(X*100), A = array:set(I, 1+array:get(I,A0), A0), - basic_stats_1(N-1, S, Sum+X, A); -basic_stats_1(0, {#{type:=Alg}, _}, Sum, A) -> + basic_uniform_1(N-1, S, Sum+X, A); +basic_uniform_1(0, {#{type:=Alg}, _}, Sum, A) -> AverN = Sum / ?LOOP, io:format("~.10w: Average: ~.4f~n", [Alg, AverN]), Counters = array:to_list(A), @@ -313,11 +322,11 @@ basic_stats_1(0, {#{type:=Alg}, _}, Sum, A) -> abs(?LOOP div 100 - Max) < 1000 orelse test_server:fail({max, Alg, Max}), ok. -basic_stats_2(N, S0, Sum, A0) when N > 0 -> +basic_uniform_2(N, S0, Sum, A0) when N > 0 -> {X,S} = rand:uniform_s(100, S0), A = array:set(X-1, 1+array:get(X-1,A0), A0), - basic_stats_2(N-1, S, Sum+X, A); -basic_stats_2(0, {#{type:=Alg}, _}, Sum, A) -> + basic_uniform_2(N-1, S, Sum+X, A); +basic_uniform_2(0, {#{type:=Alg}, _}, Sum, A) -> AverN = Sum / ?LOOP, io:format("~.10w: Average: ~.4f~n", [Alg, AverN]), Counters = tl(array:to_list(A)), @@ -332,6 +341,19 @@ basic_stats_2(0, {#{type:=Alg}, _}, Sum, A) -> abs(?LOOP div 100 - Max) < 1000 orelse test_server:fail({max, Alg, Max}), ok. +basic_normal_1(N, S0, Sum, Sq) when N > 0 -> + {X,S} = rand:normal_s(S0), + basic_normal_1(N-1, S, X+Sum, X*X+Sq); +basic_normal_1(0, {#{type:=Alg}, _}, Sum, SumSq) -> + Mean = Sum / ?LOOP, + StdDev = math:sqrt((SumSq - (Sum*Sum/?LOOP))/(?LOOP - 1)), + io:format("~.10w: Average: ~7.4f StdDev ~6.4f~n", [Alg, Mean, StdDev]), + %% Verify that the basic statistics are ok + %% be gentle we don't want to see to many failing tests + abs(Mean) < 0.005 orelse test_server:fail({average, Alg, Mean}), + abs(StdDev - 1.0) < 0.005 orelse test_server:fail({stddev, Alg, StdDev}), + ok. + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% plugin(doc) -> ["Test that the user can write algorithms"]; @@ -349,11 +371,12 @@ plugin(Config) when is_list(Config) -> %% Test implementation crypto_seed() -> {#{type=>crypto, + max=>(1 bsl 64)-1, + next=>fun crypto_next/1, uniform=>fun crypto_uniform/1, uniform_n=>fun crypto_uniform_n/2}, <<>>}. - %% Be fair and create bignums i.e. 64bits otherwise use 58bits crypto_next(<>) -> {Num, Bin}; @@ -377,15 +400,21 @@ crypto_uniform_n(N, State0) -> measure(Suite) when is_atom(Suite) -> []; measure(_Config) -> Algos = [crypto64|algs()], - io:format("RNG integer performance~n",[]), - _ = [measure_1(Algo, fun(State) -> rand:uniform_s(10000, State) end) || Algo <- Algos], - io:format("RNG float performance~n",[]), - _ = [measure_1(Algo, fun(State) -> rand:uniform_s(State) end) || Algo <- Algos], + io:format("RNG uniform integer performance~n",[]), + _ = measure_1(random, fun(State) -> {int, random:uniform_s(10000, State)} end), + _ = [measure_1(Algo, fun(State) -> {int, rand:uniform_s(10000, State)} end) || Algo <- Algos], + io:format("RNG uniform float performance~n",[]), + _ = measure_1(random, fun(State) -> {uniform, random:uniform_s(State)} end), + _ = [measure_1(Algo, fun(State) -> {uniform, rand:uniform_s(State)} end) || Algo <- Algos], + io:format("RNG normal float performance~n",[]), + io:format("~.10w: not implemented (too few bits)~n", [random]), + _ = [measure_1(Algo, fun(State) -> {normal, rand:normal_s(State)} end) || Algo <- Algos], ok. measure_1(Algo, Gen) -> Parent = self(), Seed = fun(crypto64) -> crypto_seed(); + (random) -> random:seed(os:timestamp()), get(random_seed); (Alg) -> rand:seed_s(Alg) end, @@ -402,10 +431,12 @@ measure_1(Algo, Gen) -> measure_2(N, State0, Fun) when N > 0 -> case Fun(State0) of - {Random, State} + {int, {Random, State}} when is_integer(Random), Random >= 1, Random =< 100000 -> measure_2(N-1, State, Fun); - {Random, State} when is_float(Random), Random > 0, Random < 1 -> + {uniform, {Random, State}} when is_float(Random), Random > 0, Random < 1 -> + measure_2(N-1, State, Fun); + {normal, {Random, State}} when is_float(Random) -> measure_2(N-1, State, Fun); Res -> exit({error, Res, State0}) -- cgit v1.2.3 From b428cda36b3fc692e7feee3452cde0d76f110566 Mon Sep 17 00:00:00 2001 From: James Fish Date: Wed, 4 Mar 2015 21:19:52 +0000 Subject: Fix parsing list of one test directory in ct:run_test/1 Fix support for the following cases for ct:run_test/1 options: * [{dir, [Dir]}, {suite, _}, ...] * [{dir, [Dir]}, {suite, Suite}, {group, _}, ...] * [{dir, [Dir]}, {suite, Suite}, {case, _}, ...] Previously these options would result in a function_clause error as {dir, [Dir]} was not handled when combined with a suite. --- lib/common_test/src/ct_run.erl | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/common_test/src/ct_run.erl b/lib/common_test/src/ct_run.erl index 33c4f352b0..632901837c 100644 --- a/lib/common_test/src/ct_run.erl +++ b/lib/common_test/src/ct_run.erl @@ -1627,11 +1627,15 @@ groups_and_cases(Gs, Cs) -> tests(TestDir, Suites, []) when is_list(TestDir), is_integer(hd(TestDir)) -> [{?testdir(TestDir,Suites),ensure_atom(Suites),all}]; tests(TestDir, Suite, Cases) when is_list(TestDir), is_integer(hd(TestDir)) -> + [{?testdir(TestDir,Suite),ensure_atom(Suite),Cases}]; +tests([TestDir], Suite, Cases) when is_list(TestDir), is_integer(hd(TestDir)) -> [{?testdir(TestDir,Suite),ensure_atom(Suite),Cases}]. tests([{Dir,Suite}],Cases) -> [{?testdir(Dir,Suite),ensure_atom(Suite),Cases}]; tests(TestDir, Suite) when is_list(TestDir), is_integer(hd(TestDir)) -> - tests(TestDir, ensure_atom(Suite), all). + tests(TestDir, ensure_atom(Suite), all); +tests([TestDir], Suite) when is_list(TestDir), is_integer(hd(TestDir)) -> + tests(TestDir, ensure_atom(Suite), all). tests(DirSuites) when is_list(DirSuites), is_tuple(hd(DirSuites)) -> [{?testdir(Dir,Suite),ensure_atom(Suite),all} || {Dir,Suite} <- DirSuites]; tests(TestDir) when is_list(TestDir), is_integer(hd(TestDir)) -> -- cgit v1.2.3 From 00ff3b3776a62402e7977fd9172a926ad62ea449 Mon Sep 17 00:00:00 2001 From: Stavros Aronis Date: Thu, 23 Apr 2015 11:15:47 +0200 Subject: Fix a bug related to constraints generated for erlang:'*'/2 For Rst = A1 * A2, typesig for erlang:'*'/2 was constraining the arguments A1 and A2 in the 'reverse' direction by requiring that A2 is a subtype of Rst div A1, unless A1 is a hard zero. This is not correct: if for example both Rst and A1 are non_negative, such a constraint will first force A1 to be non-zero for the division to go through and then require A2 to be non_negative as non_negative div positive = non_negative, always (see commited test). In the fixed version, we are not constraining an argument if the other operand *may* be zero. --- lib/dialyzer/src/dialyzer_typesig.erl | 8 ++++---- lib/dialyzer/test/small_SUITE_data/src/inv_mult.erl | 15 +++++++++++++++ 2 files changed, 19 insertions(+), 4 deletions(-) create mode 100644 lib/dialyzer/test/small_SUITE_data/src/inv_mult.erl (limited to 'lib') diff --git a/lib/dialyzer/src/dialyzer_typesig.erl b/lib/dialyzer/src/dialyzer_typesig.erl index 1737bfd3a9..6c14860d7d 100644 --- a/lib/dialyzer/src/dialyzer_typesig.erl +++ b/lib/dialyzer/src/dialyzer_typesig.erl @@ -1579,11 +1579,11 @@ get_bif_constr({M, F, A} = _BIF, Dst, Args, _State) -> eval_inv_arith('+', _Pos, Dst, Arg) -> bif_return(erlang, '-', 2, [Dst, Arg]); eval_inv_arith('*', _Pos, Dst, Arg) -> - case t_number_vals(Arg) of - [0] -> t_integer(); - _ -> + Zero = t_from_term(0), + case t_is_none(t_inf(Arg, Zero)) of + false -> t_integer(); + true -> TmpRet = bif_return(erlang, 'div', 2, [Dst, Arg]), - Zero = t_from_term(0), %% If 0 is not part of the result, it cannot be part of the argument. case t_is_subtype(Zero, Dst) of false -> t_subtract(TmpRet, Zero); diff --git a/lib/dialyzer/test/small_SUITE_data/src/inv_mult.erl b/lib/dialyzer/test/small_SUITE_data/src/inv_mult.erl new file mode 100644 index 0000000000..3413556813 --- /dev/null +++ b/lib/dialyzer/test/small_SUITE_data/src/inv_mult.erl @@ -0,0 +1,15 @@ +%% Dialyzer was too constraining when checking the relation between the +%% arguments and result of a multiplication. We should not constrain an argument +%% if the other operand *may* be zero. +%% +%% Bug found by Kostis Sagonas, fixed by Stavros Aronis + +-module(inv_mult). +-compile(export_all). + +main(L) -> + N = -1 * length(L), + fact(N). + +fact(0) -> 1; +fact(N) -> N * fact(N-1). -- cgit v1.2.3 From 098f7b59ef26c57f8b759c14a6f3757534d50175 Mon Sep 17 00:00:00 2001 From: Zandra Hird Date: Thu, 16 Apr 2015 13:47:44 +0200 Subject: make it possible to use a file to configure mime types The documentation specifies that a file can be used to configure mime types, but currently it isn't working. With this change it works as documented. --- lib/inets/src/http_server/httpd_conf.erl | 11 ++++-- lib/inets/test/httpd_SUITE.erl | 41 +++++++++++++++++++--- .../httpd_SUITE_data/server_root/config/mime.types | 4 +++ 3 files changed, 49 insertions(+), 7 deletions(-) create mode 100644 lib/inets/test/httpd_SUITE_data/server_root/config/mime.types (limited to 'lib') diff --git a/lib/inets/src/http_server/httpd_conf.erl b/lib/inets/src/http_server/httpd_conf.erl index 78dda794db..2cafed89f2 100644 --- a/lib/inets/src/http_server/httpd_conf.erl +++ b/lib/inets/src/http_server/httpd_conf.erl @@ -785,8 +785,15 @@ fix_mime_types(ConfigList0) -> [{"html","text/html"},{"htm","text/html"}]} | ConfigList0] end; - _ -> - ConfigList0 + MimeTypes -> + case filelib:is_file(MimeTypes) of + true -> + {ok, MimeTypesList} = load_mime_types(MimeTypes), + ConfigList = proplists:delete(mime_types, ConfigList0), + [{mime_types, MimeTypesList} | ConfigList]; + false -> + ConfigList0 + end end. store({mime_types,MimeTypesList},ConfigList) -> diff --git a/lib/inets/test/httpd_SUITE.erl b/lib/inets/test/httpd_SUITE.erl index 342004f19b..260c09036c 100644 --- a/lib/inets/test/httpd_SUITE.erl +++ b/lib/inets/test/httpd_SUITE.erl @@ -66,7 +66,8 @@ all() -> {group, http_security}, {group, https_security}, {group, http_reload}, - {group, https_reload} + {group, https_reload}, + {group, http_mime_types} ]. groups() -> @@ -89,6 +90,7 @@ groups() -> {https_security, [], [{group, security}]}, {http_reload, [], [{group, reload}]}, {https_reload, [], [{group, reload}]}, + {http_mime_types, [], [alias_1_1, alias_1_0, alias_0_9]}, {limit, [], [max_clients_1_1, max_clients_1_0, max_clients_0_9]}, {reload, [], [non_disturbing_reconfiger_dies, disturbing_reconfiger_dies, @@ -192,7 +194,8 @@ init_per_group(Group, Config0) when Group == http_basic; Group == http_auth_api_dets; Group == http_auth_api_mnesia; Group == http_security; - Group == http_reload + Group == http_reload; + Group == http_mime_types -> ok = start_apps(Group), init_httpd(Group, [{type, ip_comm} | Config0]); @@ -236,7 +239,8 @@ end_per_group(Group, _Config) when Group == http_basic; Group == http_auth_api_mnesia; Group == http_htaccess; Group == http_security; - Group == http_reload + Group == http_reload; + Group == http_mime_types -> inets:stop(); end_per_group(Group, _Config) when Group == https_basic; @@ -857,6 +861,24 @@ cgi_chunked_encoding_test(Config) when is_list(Config) -> ?config(node, Config), Requests). %%------------------------------------------------------------------------- +alias_1_1() -> + [{doc, "Test mod_alias"}]. + +alias_1_1(Config) when is_list(Config) -> + alias([{http_version, "HTTP/1.1"} | Config]). + +alias_1_0() -> + [{doc, "Test mod_alias"}]. + +alias_1_0(Config) when is_list(Config) -> + alias([{http_version, "HTTP/1.0"} | Config]). + +alias_0_9() -> + [{doc, "Test mod_alias"}]. + +alias_0_9(Config) when is_list(Config) -> + alias([{http_version, "HTTP/0.9"} | Config]). + alias() -> [{doc, "Test mod_alias"}]. @@ -915,7 +937,6 @@ trace(Config) when is_list(Config) -> Cb = ?config(version_cb, Config), Cb:trace(?config(type, Config), ?config(port, Config), ?config(host, Config), ?config(node, Config)). - %%------------------------------------------------------------------------- light() -> ["Test light load"]. @@ -1276,22 +1297,26 @@ setup_server_dirs(ServerRoot, DocRoot, DataDir) -> CgiDir = filename:join(ServerRoot, "cgi-bin"), AuthDir = filename:join(ServerRoot, "auth"), PicsDir = filename:join(ServerRoot, "icons"), + ConfigDir = filename:join(ServerRoot, "config"), ok = file:make_dir(ServerRoot), ok = file:make_dir(DocRoot), ok = file:make_dir(CgiDir), ok = file:make_dir(AuthDir), ok = file:make_dir(PicsDir), + ok = file:make_dir(ConfigDir), DocSrc = filename:join(DataDir, "server_root/htdocs"), AuthSrc = filename:join(DataDir, "server_root/auth"), CgiSrc = filename:join(DataDir, "server_root/cgi-bin"), PicsSrc = filename:join(DataDir, "server_root/icons"), + ConfigSrc = filename:join(DataDir, "server_root/config"), inets_test_lib:copy_dirs(DocSrc, DocRoot), inets_test_lib:copy_dirs(AuthSrc, AuthDir), inets_test_lib:copy_dirs(CgiSrc, CgiDir), inets_test_lib:copy_dirs(PicsSrc, PicsDir), + inets_test_lib:copy_dirs(ConfigSrc, ConfigDir), Cgi = case test_server:os_type() of {win32, _} -> @@ -1329,7 +1354,8 @@ start_apps(Group) when Group == http_basic; Group == http_auth_api_mnesia; Group == https_htaccess; Group == https_security; - Group == https_reload-> + Group == https_reload; + Group == http_mime_types-> inets_test_lib:start_apps([inets]). server_start(_, HttpdConfig) -> @@ -1417,6 +1443,11 @@ server_config(http_security, Config) -> server_config(https_security, Config) -> ServerRoot = ?config(server_root, Config), tl(auth_conf(ServerRoot)) ++ security_conf(ServerRoot) ++ server_config(https, Config); +server_config(http_mime_types, Config0) -> + Config1 = basic_conf() ++ server_config(http, Config0), + ServerRoot = ?config(server_root, Config0), + MimeTypesFile = filename:join([ServerRoot,"config", "mime.types"]), + [{mime_types, MimeTypesFile} | proplists:delete(mime_types, Config1)]; server_config(http, Config) -> ServerRoot = ?config(server_root, Config), diff --git a/lib/inets/test/httpd_SUITE_data/server_root/config/mime.types b/lib/inets/test/httpd_SUITE_data/server_root/config/mime.types new file mode 100644 index 0000000000..b68cff21a6 --- /dev/null +++ b/lib/inets/test/httpd_SUITE_data/server_root/config/mime.types @@ -0,0 +1,4 @@ +text/html html +text/html htm +text/html shtml +image/gif gif -- cgit v1.2.3 From 3339aabf37dc65fd3fa66482764fc9c533d65933 Mon Sep 17 00:00:00 2001 From: Dan Gudmundsson Date: Wed, 6 May 2015 13:33:33 +0200 Subject: mnesia: dirty error messages did not behave as documented The docs express that exit({aborted, Reason}) are called when an error occur. --- lib/mnesia/src/mnesia.erl | 10 +++------- lib/mnesia/src/mnesia_lib.erl | 2 +- lib/mnesia/test/mnesia_evil_coverage_test.erl | 6 +++--- 3 files changed, 7 insertions(+), 11 deletions(-) (limited to 'lib') diff --git a/lib/mnesia/src/mnesia.erl b/lib/mnesia/src/mnesia.erl index f501a4485b..b9c2fd915c 100644 --- a/lib/mnesia/src/mnesia.erl +++ b/lib/mnesia/src/mnesia.erl @@ -306,6 +306,8 @@ ms() -> -spec abort(_) -> no_return(). +abort(Reason = {aborted, _}) -> + exit(Reason); abort(Reason) -> exit({aborted, Reason}). @@ -1626,13 +1628,7 @@ dirty_read(Oid) -> dirty_read(Tab, Key) when is_atom(Tab), Tab /= schema -> -%% case catch ?ets_lookup(Tab, Key) of -%% {'EXIT', _} -> - %% Bad luck, we have to perform a real lookup - dirty_rpc(Tab, mnesia_lib, db_get, [Tab, Key]); -%% Val -> -%% Val -%% end; + dirty_rpc(Tab, mnesia_lib, db_get, [Tab, Key]); dirty_read(Tab, _Key) -> abort({bad_type, Tab}). diff --git a/lib/mnesia/src/mnesia_lib.erl b/lib/mnesia/src/mnesia_lib.erl index 7bd207f816..fc7362a31d 100644 --- a/lib/mnesia/src/mnesia_lib.erl +++ b/lib/mnesia/src/mnesia_lib.erl @@ -411,7 +411,7 @@ pr_other(Var) -> verbose("~p (~p) val(mnesia_gvar, ~w) -> ~p ~n", [self(), process_info(self(), registered_name), Var, Why]), - exit(Why). + mnesia:abort(Why). %% Some functions for list valued variables add(Var, Val) -> diff --git a/lib/mnesia/test/mnesia_evil_coverage_test.erl b/lib/mnesia/test/mnesia_evil_coverage_test.erl index 2d1623b6ca..430c1f1d84 100644 --- a/lib/mnesia/test/mnesia_evil_coverage_test.erl +++ b/lib/mnesia/test/mnesia_evil_coverage_test.erl @@ -1338,11 +1338,11 @@ user_properties(Config) when is_list(Config) -> ?match([], mnesia:table_info(Tab2, user_properties)), ?match([], mnesia:table_info(Tab3, user_properties)), - ?match({'EXIT', {no_exists, {Tab1, user_property, PropKey}}}, + ?match({'EXIT', {aborted, {no_exists, {Tab1, user_property, PropKey}}}}, mnesia:read_table_property(Tab1, PropKey)), - ?match({'EXIT', {no_exists, {Tab2, user_property, PropKey}}}, + ?match({'EXIT', {aborted, {no_exists, {Tab2, user_property, PropKey}}}}, mnesia:read_table_property(Tab2, PropKey)), - ?match({'EXIT', {no_exists, {Tab3, user_property, PropKey}}}, + ?match({'EXIT', {aborted, {no_exists, {Tab3, user_property, PropKey}}}}, mnesia:read_table_property(Tab3, PropKey)), ?match({atomic, ok}, mnesia:write_table_property(Tab1, Prop)), -- cgit v1.2.3 From fd9525a6764e3aa0c29e6456ddaf75035559ebd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Wed, 6 May 2015 14:28:42 +0200 Subject: Correct filename:split(<<"">>) filename:split("") returns [], while filename:split(<<"">>) returns [<<"/">>]. Since the support in the filename module for binary arguments is much more recent than support for strings, change filename:split(<<"">>) so that it returns []. Noticed-by: KOUCHANG --- lib/stdlib/src/filename.erl | 2 +- lib/stdlib/test/filename_SUITE.erl | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/stdlib/src/filename.erl b/lib/stdlib/src/filename.erl index 632af17e2a..68bd4f71cc 100644 --- a/lib/stdlib/src/filename.erl +++ b/lib/stdlib/src/filename.erl @@ -648,7 +648,7 @@ split(Name0) -> unix_splitb(Name) -> L = binary:split(Name,[<<"/">>],[global]), LL = case L of - [<<>>|Rest] -> + [<<>>|Rest] when Rest =/= [] -> [<<"/">>|Rest]; _ -> L diff --git a/lib/stdlib/test/filename_SUITE.erl b/lib/stdlib/test/filename_SUITE.erl index 6f1d1a891d..70e7ad9788 100644 --- a/lib/stdlib/test/filename_SUITE.erl +++ b/lib/stdlib/test/filename_SUITE.erl @@ -395,6 +395,8 @@ split(Config) when is_list(Config) -> ?line ["foo", "bar", "hello"]= filename:split("foo////bar//hello"), ?line ["foo", "bar", "hello"]= filename:split(["foo//",'//bar//h',"ello"]), ?line ["foo", "bar", "hello"]= filename:split(["foo//",'//bar//h'|ello]), + ["/"] = filename:split("/"), + [] = filename:split(""), case os:type() of {win32,_} -> ?line ["a:/","msdev","include"] = @@ -767,6 +769,8 @@ split_bin(Config) when is_list(Config) -> [<<"/">>,<<"usr">>,<<"local">>,<<"bin">>] = filename:split(<<"/usr/local/bin">>), [<<"foo">>,<<"bar">>]= filename:split(<<"foo/bar">>), [<<"foo">>, <<"bar">>, <<"hello">>]= filename:split(<<"foo////bar//hello">>), + [<<"/">>] = filename:split(<<"/">>), + [] = filename:split(<<"">>), case os:type() of {win32,_} -> [<<"a:/">>,<<"msdev">>,<<"include">>] = -- cgit v1.2.3 From fbaf4210a0d276be98bed76a7295334a50b7a4b3 Mon Sep 17 00:00:00 2001 From: Rickard Green Date: Mon, 30 Mar 2015 18:24:40 +0200 Subject: Replace usage of erlang:now() in line-tracing --- lib/test_server/include/test_server.hrl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/test_server/include/test_server.hrl b/lib/test_server/include/test_server.hrl index 36e7e1f83d..f206374116 100644 --- a/lib/test_server/include/test_server.hrl +++ b/lib/test_server/include/test_server.hrl @@ -21,7 +21,7 @@ -line_trace(true). -define(line, io:format(lists:concat([?MODULE,",",integer_to_list(?LINE),": ~p"]), - [erlang:now()]),). + [erlang:monotonic_time()-erlang:system_info(start_time)]),). -else. -define(line,). -endif. -- cgit v1.2.3 From 446dbe8accfdc27ebe72161d763888acc0c90d1c Mon Sep 17 00:00:00 2001 From: Hans Nilsson Date: Wed, 6 May 2015 17:41:04 +0200 Subject: eldap: Test suite uppdated to new time handling --- lib/eldap/test/eldap_basic_SUITE.erl | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'lib') diff --git a/lib/eldap/test/eldap_basic_SUITE.erl b/lib/eldap/test/eldap_basic_SUITE.erl index 137c61b2d9..8d754e934c 100644 --- a/lib/eldap/test/eldap_basic_SUITE.erl +++ b/lib/eldap/test/eldap_basic_SUITE.erl @@ -896,9 +896,9 @@ client_timeout(Fun, Config) -> T = 1000, case eldap:open([Host], [{timeout,T},{port,Port}|Opts]) of {ok,H} -> - T0 = now(), + T0 = erlang:monotonic_time(), {error,{gen_tcp_error,timeout}} = Fun(H), - T_op = diff(T0,now()), + T_op = ms_passed(T0), ct:log("Time = ~p, Timeout spec = ~p",[T_op,T]), if T_op < T -> @@ -910,8 +910,12 @@ client_timeout(Fun, Config) -> Other -> ct:fail("eldap:open failed: ~p",[Other]) end. -diff({M1,S1,U1},{M2,S2,U2}) -> - ( ((M2-M1)*1000 + (S2-S1))*1000 + (U2-U1) ). +%% Help function, elapsed milliseconds since T0 +ms_passed(T0) -> + %% OTP 18 + erlang:convert_time_unit(erlang:monotonic_time() - T0, + native, + micro_seconds) / 1000. %%%---------------------------------------------------------------- init_ssl_certs_et_al(Config) -> -- cgit v1.2.3 From 968356217ac8e661338094c2ab19ff5d65f95782 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Wed, 6 May 2015 09:51:07 +0200 Subject: stdlib: Refactor away ?line macro --- lib/stdlib/test/ets_SUITE.erl | 35 +++++++++++++++++------------------ 1 file changed, 17 insertions(+), 18 deletions(-) (limited to 'lib') diff --git a/lib/stdlib/test/ets_SUITE.erl b/lib/stdlib/test/ets_SUITE.erl index 5774d774b5..2a02b2e8b5 100644 --- a/lib/stdlib/test/ets_SUITE.erl +++ b/lib/stdlib/test/ets_SUITE.erl @@ -3821,46 +3821,45 @@ match_object(Config) when is_list(Config) -> repeat_for_opts(match_object_do). match_object_do(Opts) -> - ?line EtsMem = etsmem(), - ?line Tab = ets_new(foobar, Opts), - ?line fill_tab(Tab, foo), - ?line ets:insert(Tab, {{one, 4}, 4}), - ?line ets:insert(Tab,{{one,5},5}), - ?line ets:insert(Tab,{{two,4},4}), - ?line ets:insert(Tab,{{two,5},6}), - ?line ets:insert(Tab, {#{camembert=>cabécou},7}), - ?line case ets:match_object(Tab, {{one, '_'}, '$0'}) of + EtsMem = etsmem(), + Tab = ets_new(foobar, Opts), + fill_tab(Tab, foo), + ets:insert(Tab, {{one, 4}, 4}), + ets:insert(Tab,{{one,5},5}), + ets:insert(Tab,{{two,4},4}), + ets:insert(Tab,{{two,5},6}), + ets:insert(Tab, {#{camembert=>cabécou},7}), + case ets:match_object(Tab, {{one, '_'}, '$0'}) of [{{one,5},5},{{one,4},4}] -> ok; [{{one,4},4},{{one,5},5}] -> ok; _ -> ?t:fail("ets:match_object() returned something funny.") end, - ?line case ets:match_object(Tab, {{two, '$1'}, '$0'}) of + case ets:match_object(Tab, {{two, '$1'}, '$0'}) of [{{two,5},6},{{two,4},4}] -> ok; [{{two,4},4},{{two,5},6}] -> ok; _ -> ?t:fail("ets:match_object() returned something funny.") end, - ?line case ets:match_object(Tab, {{two, '$9'}, '$4'}) of + case ets:match_object(Tab, {{two, '$9'}, '$4'}) of [{{two,5},6},{{two,4},4}] -> ok; [{{two,4},4},{{two,5},6}] -> ok; _ -> ?t:fail("ets:match_object() returned something funny.") end, - ?line case ets:match_object(Tab, {{two, '$9'}, '$22'}) of + case ets:match_object(Tab, {{two, '$9'}, '$22'}) of [{{two,5},6},{{two,4},4}] -> ok; [{{two,4},4},{{two,5},6}] -> ok; _ -> ?t:fail("ets:match_object() returned something funny.") end, % Check that maps are inspected for variables. - [{#{camembert:=cabécou},7}] = - ets:match_object(Tab, {#{camembert=>'_'},7}), + [{#{camembert:=cabécou},7}] = ets:match_object(Tab, {#{camembert=>'_'},7}), {'EXIT',{badarg,_}} = (catch ets:match_object(Tab, {#{'$1'=>'_'},7})), % Check that unsucessful match returns an empty list. - ?line [] = ets:match_object(Tab, {{three,'$0'}, '$92'}), + [] = ets:match_object(Tab, {{three,'$0'}, '$92'}), % Check that '$0' equals '_'. Len = length(ets:match_object(Tab, '$0')), Len = length(ets:match_object(Tab, '_')), - ?line if Len > 4 -> ok end, - ?line true = ets:delete(Tab), - ?line verify_etsmem(EtsMem). + if Len > 4 -> ok end, + true = ets:delete(Tab), + verify_etsmem(EtsMem). match_object2(suite) -> []; match_object2(doc) -> ["Tests that db_match_object does not generate " -- cgit v1.2.3 From f436d84d990bb06e6bbbf55659d4f3a47bc1c556 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Thu, 7 May 2015 10:05:48 +0200 Subject: stdlib: Strengthen ETS Maps tests The additional tests in match_object focus on ordered sets. --- lib/stdlib/test/ets_SUITE.erl | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) (limited to 'lib') diff --git a/lib/stdlib/test/ets_SUITE.erl b/lib/stdlib/test/ets_SUITE.erl index 2a02b2e8b5..3505fd91a7 100644 --- a/lib/stdlib/test/ets_SUITE.erl +++ b/lib/stdlib/test/ets_SUITE.erl @@ -3829,6 +3829,10 @@ match_object_do(Opts) -> ets:insert(Tab,{{two,4},4}), ets:insert(Tab,{{two,5},6}), ets:insert(Tab, {#{camembert=>cabécou},7}), + ets:insert(Tab, {#{"hi"=>"hello","wazzup"=>"awesome","1337"=>"42"},8}), + ets:insert(Tab, {#{"hi"=>"hello",#{"wazzup"=>3}=>"awesome","1337"=>"42"},9}), + ets:insert(Tab, {#{"hi"=>"hello","wazzup"=>#{"awesome"=>3},"1337"=>"42"},10}), + case ets:match_object(Tab, {{one, '_'}, '$0'}) of [{{one,5},5},{{one,4},4}] -> ok; [{{one,4},4},{{one,5},5}] -> ok; @@ -3851,6 +3855,32 @@ match_object_do(Opts) -> end, % Check that maps are inspected for variables. [{#{camembert:=cabécou},7}] = ets:match_object(Tab, {#{camembert=>'_'},7}), + + [{#{"hi":="hello",#{"wazzup"=>3}:="awesome","1337":="42"},9}] = + ets:match_object(Tab, {#{#{"wazzup"=>3}=>"awesome","hi"=>"hello","1337"=>"42"},9}), + [{#{"hi":="hello",#{"wazzup"=>3}:="awesome","1337":="42"},9}] = + ets:match_object(Tab, {#{#{"wazzup"=>3}=>"awesome","hi"=>"hello","1337"=>'_'},'_'}), + [{#{"hi":="hello","wazzup":=#{"awesome":=3},"1337":="42"},10}] = + ets:match_object(Tab, {#{"wazzup"=>'_',"hi"=>'_',"1337"=>'_'},10}), + + %% multiple patterns + Pat = {{#{#{"wazzup"=>3}=>"awesome","hi"=>"hello","1337"=>'_'},'$1'},[{is_integer,'$1'}],['$_']}, + [{#{"hi":="hello",#{"wazzup"=>3}:="awesome","1337":="42"},9}] = + ets:select(Tab, [Pat,Pat,Pat,Pat]), + case ets:match_object(Tab, {#{"hi"=>"hello","wazzup"=>'_',"1337"=>"42"},'_'}) of + [{#{"1337" := "42","hi" := "hello","wazzup" := "awesome"},8}, + {#{"1337" := "42","hi" := "hello","wazzup" := #{"awesome" := 3}},10}] -> ok; + [{#{"1337" := "42","hi" := "hello","wazzup" := #{"awesome" := 3}},10}, + {#{"1337" := "42","hi" := "hello","wazzup" := "awesome"},8}] -> ok; + _ -> ?t:fail("ets:match_object() returned something funny.") + end, + case ets:match_object(Tab, {#{"hi"=>'_'},'_'}) of + [{#{"1337":="42", "hi":="hello"},_}, + {#{"1337":="42", "hi":="hello"},_}, + {#{"1337":="42", "hi":="hello"},_}] -> ok; + _ -> ?t:fail("ets:match_object() returned something funny.") + end, + {'EXIT',{badarg,_}} = (catch ets:match_object(Tab, {#{'$1'=>'_'},7})), % Check that unsucessful match returns an empty list. [] = ets:match_object(Tab, {{three,'$0'}, '$92'}), -- cgit v1.2.3 From 59baf619a99a3571875556b3402d0a97260ef3ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Wed, 6 May 2015 16:52:51 +0200 Subject: stdlib: Strengthen ETS Maps tests Strengthen tests of large Maps in ETS. --- lib/stdlib/test/ets_SUITE.erl | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) (limited to 'lib') diff --git a/lib/stdlib/test/ets_SUITE.erl b/lib/stdlib/test/ets_SUITE.erl index 3505fd91a7..27de83cdc9 100644 --- a/lib/stdlib/test/ets_SUITE.erl +++ b/lib/stdlib/test/ets_SUITE.erl @@ -3824,7 +3824,7 @@ match_object_do(Opts) -> EtsMem = etsmem(), Tab = ets_new(foobar, Opts), fill_tab(Tab, foo), - ets:insert(Tab, {{one, 4}, 4}), + ets:insert(Tab,{{one,4},4}), ets:insert(Tab,{{one,5},5}), ets:insert(Tab,{{two,4},4}), ets:insert(Tab,{{two,5},6}), @@ -3832,6 +3832,11 @@ match_object_do(Opts) -> ets:insert(Tab, {#{"hi"=>"hello","wazzup"=>"awesome","1337"=>"42"},8}), ets:insert(Tab, {#{"hi"=>"hello",#{"wazzup"=>3}=>"awesome","1337"=>"42"},9}), ets:insert(Tab, {#{"hi"=>"hello","wazzup"=>#{"awesome"=>3},"1337"=>"42"},10}), + Is = lists:seq(1,100), + M1 = maps:from_list([{I,I}||I <- Is]), + M2 = maps:from_list([{I,"hi"}||I <- Is]), + ets:insert(Tab, {M1,11}), + ets:insert(Tab, {M2,12}), case ets:match_object(Tab, {{one, '_'}, '$0'}) of [{{one,5},5},{{one,4},4}] -> ok; @@ -3853,6 +3858,7 @@ match_object_do(Opts) -> [{{two,4},4},{{two,5},6}] -> ok; _ -> ?t:fail("ets:match_object() returned something funny.") end, + % Check that maps are inspected for variables. [{#{camembert:=cabécou},7}] = ets:match_object(Tab, {#{camembert=>'_'},7}), @@ -3881,8 +3887,18 @@ match_object_do(Opts) -> _ -> ?t:fail("ets:match_object() returned something funny.") end, + %% match large maps + [{#{1:=1,2:=2,99:=99,100:=100},11}] = ets:match_object(Tab, {M1,11}), + [{#{1:="hi",2:="hi",99:="hi",100:="hi"},12}] = ets:match_object(Tab, {M2,12}), + case ets:match_object(Tab, {#{1=>'_',2=>'_'},'_'}) of + %% only match a part of the map + [{#{1:=1,5:=5,99:=99,100:=100},11},{#{1:="hi",6:="hi",99:="hi"},12}] -> ok; + [{#{1:="hi",2:="hi",59:="hi"},12},{#{1:=1,2:=2,39:=39,100:=100},11}] -> ok; + _ -> ?t:fail("ets:match_object() returned something funny.") + end, {'EXIT',{badarg,_}} = (catch ets:match_object(Tab, {#{'$1'=>'_'},7})), - % Check that unsucessful match returns an empty list. + + % Check that unsuccessful match returns an empty list. [] = ets:match_object(Tab, {{three,'$0'}, '$92'}), % Check that '$0' equals '_'. Len = length(ets:match_object(Tab, '$0')), -- cgit v1.2.3 From 36fe05d30ecb1bc7b8d4665bff38caf61c9ae0f8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Thu, 7 May 2015 11:57:49 +0200 Subject: stdlib: Strengthen ETS Maps tests Ensure db_has_variable is tested for large Maps as well. --- lib/stdlib/test/ets_SUITE.erl | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'lib') diff --git a/lib/stdlib/test/ets_SUITE.erl b/lib/stdlib/test/ets_SUITE.erl index 27de83cdc9..41bd4af241 100644 --- a/lib/stdlib/test/ets_SUITE.erl +++ b/lib/stdlib/test/ets_SUITE.erl @@ -3896,7 +3896,15 @@ match_object_do(Opts) -> [{#{1:="hi",2:="hi",59:="hi"},12},{#{1:=1,2:=2,39:=39,100:=100},11}] -> ok; _ -> ?t:fail("ets:match_object() returned something funny.") end, + case ets:match_object(Tab, {maps:from_list([{I,'_'}||I<-Is]),'_'}) of + %% only match a part of the map + [{#{1:=1,5:=5,99:=99,100:=100},11},{#{1:="hi",6:="hi",99:="hi"},12}] -> ok; + [{#{1:="hi",2:="hi",59:="hi"},12},{#{1:=1,2:=2,39:=39,100:=100},11}] -> ok; + _ -> ?t:fail("ets:match_object() returned something funny.") + end, {'EXIT',{badarg,_}} = (catch ets:match_object(Tab, {#{'$1'=>'_'},7})), + Mve = maps:from_list([{list_to_atom([$$|integer_to_list(I)]),'_'}||I<-Is]), + {'EXIT',{badarg,_}} = (catch ets:match_object(Tab, {Mve,11})), % Check that unsuccessful match returns an empty list. [] = ets:match_object(Tab, {{three,'$0'}, '$92'}), -- cgit v1.2.3 From fc1029c74093fde14241ca664c9341fcc8be5fd3 Mon Sep 17 00:00:00 2001 From: Richard Carlsson Date: Thu, 16 Apr 2015 14:30:55 +0200 Subject: Add module_info entry for native code --- lib/test_server/src/test_server.erl | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) (limited to 'lib') diff --git a/lib/test_server/src/test_server.erl b/lib/test_server/src/test_server.erl index 7cb9c4bb5a..785e687b92 100644 --- a/lib/test_server/src/test_server.erl +++ b/lib/test_server/src/test_server.erl @@ -2491,11 +2491,7 @@ appup_test(App) -> %% Checks wether the module is natively compiled or not. is_native(Mod) -> - case catch Mod:module_info(native_addresses) of - [_|_] -> true; - _Other -> false - end. - + (catch Mod:module_info(native)) =:= true. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% comment(String) -> ok -- cgit v1.2.3 From e47490f83e561a45cee9e8f72f1e1f91f19c60b7 Mon Sep 17 00:00:00 2001 From: Richard Carlsson Date: Thu, 16 Apr 2015 11:28:22 +0200 Subject: Set module_info md5 for native modules properly Use the md5 of the native code chunk instead of the Beam code md5. --- lib/kernel/src/hipe_unified_loader.erl | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'lib') diff --git a/lib/kernel/src/hipe_unified_loader.erl b/lib/kernel/src/hipe_unified_loader.erl index 2d124d95b7..49d4a8fe54 100644 --- a/lib/kernel/src/hipe_unified_loader.erl +++ b/lib/kernel/src/hipe_unified_loader.erl @@ -194,6 +194,7 @@ load_common(Mod, Bin, Beam, OldReferencesToPatch) -> CodeSize, CodeBinary, Refs, 0,[] % ColdSize, CRrefs ] = binary_to_term(Bin), + MD5 = erlang:md5(Bin), % use md5 of actual running code for module_info ?debug_msg("***** ErLLVM *****~nVersion: ~s~nCheckSum: ~w~nConstAlign: ~w~n" ++ "ConstSize: ~w~nConstMap: ~w~nLabelMap: ~w~nExportMap ~w~nRefs ~w~n", [Version, CheckSum, ConstAlign, ConstSize, ConstMap, LabelMap, ExportMap, @@ -254,7 +255,8 @@ load_common(Mod, Bin, Beam, OldReferencesToPatch) -> AddressesOfClosuresToPatch = calculate_addresses(ClosurePatches, CodeAddress, Addresses), export_funs(Addresses), - export_funs(Mod, BeamBinary, Addresses, AddressesOfClosuresToPatch) + export_funs(Mod, MD5, BeamBinary, + Addresses, AddressesOfClosuresToPatch) end, %% Redirect references to the old module to the new module's BEAM stub. patch_to_emu_step2(OldReferencesToPatch), @@ -430,9 +432,9 @@ export_funs([FunDef | Addresses]) -> export_funs([]) -> ok. -export_funs(Mod, Beam, Addresses, ClosuresToPatch) -> +export_funs(Mod, MD5, Beam, Addresses, ClosuresToPatch) -> Fs = [{F,A,Address} || #fundef{address=Address, mfa={_M,F,A}} <- Addresses], - Mod = code:make_stub_module(Mod, Beam, {Fs,ClosuresToPatch}), + Mod = code:make_stub_module(Mod, Beam, {Fs,ClosuresToPatch,MD5}), ok. %%======================================================================== -- cgit v1.2.3 From a99b7ff68aa194c260134ab2461af1a14a03e697 Mon Sep 17 00:00:00 2001 From: tmanevik Date: Thu, 23 Apr 2015 15:06:05 +0200 Subject: Editorial changes --- lib/public_key/doc/src/cert_records.xml | 265 ++++++++------ lib/public_key/doc/src/introduction.xml | 23 +- lib/public_key/doc/src/part.xml | 9 +- lib/public_key/doc/src/public_key.xml | 505 +++++++++++++++----------- lib/public_key/doc/src/public_key_records.xml | 40 +- lib/public_key/doc/src/records.xml | 47 +++ lib/public_key/doc/src/ref_man.xml | 4 +- lib/public_key/doc/src/using_public_key.xml | 221 +++++------ 8 files changed, 643 insertions(+), 471 deletions(-) create mode 100644 lib/public_key/doc/src/records.xml (limited to 'lib') diff --git a/lib/public_key/doc/src/cert_records.xml b/lib/public_key/doc/src/cert_records.xml index 857a39bf40..4d4533fe21 100644 --- a/lib/public_key/doc/src/cert_records.xml +++ b/lib/public_key/doc/src/cert_records.xml @@ -23,7 +23,7 @@ The Initial Developer of the Original Code is Ericsson AB. - Certificate records + Certificate Records Ingela Anderton Andin @@ -34,66 +34,81 @@ cert_records.xml -

This chapter briefly describes erlang records derived from ASN1 - specifications used to handle X509 certificates and CertificationRequest. - The intent is to describe the data types -and not to specify the semantics of each component. For information on the -semantics, please see This section briefly describes Erlang records derived from ASN.1 + specifications used to handle X509 certificates and CertificationRequest. + The scope is to describe the data types of each component, + not the semantics. For information on the semantics, refer to RFC 5280 and PKCS-10.

Use the following include directive to get access to the - records and constant macros (OIDs) described in the following sections.

+ records and constant macros (OIDs) described in the following sections:

-include_lib("public_key/include/public_key.hrl"). -

The used ASN1 specifications are available asn1 subdirectory - of the application public_key. -

+

The used ASN.1 specifications are available in the asn1 subdirectory + of the public_key application.

Common Data Types -

Common non standard erlang - data types used to described the record fields in the - below sections are defined in public key reference manual or - follows here.

- -

time() = uct_time() | general_time()

- -

uct_time() = {utcTime, "YYMMDDHHMMSSZ"}

- -

general_time() = {generalTime, "YYYYMMDDHHMMSSZ"}

- -

- general_name() = {rfc822Name, string()} | {dNSName, string()} - | {x400Address, string()} | {directoryName, - {rdnSequence, [#AttributeTypeAndValue'{}]}} | - | {eidPartyName, special_string()} - | {eidPartyName, special_string(), special_string()} - | {uniformResourceIdentifier, string()} | {ipAddress, string()} | - {registeredId, oid()} | {otherName, term()} -

+

Common non-standard Erlang + data types used to describe the record fields in the + following sections are defined in the public_key Reference Manual, or + follows here:

-

- special_string() = - {teletexString, string()} | {printableString, string()} | - {universalString, string()} | {utf8String, binary()} | - {bmpString, string()} -

- -

- dist_reason() = unused | keyCompromise | cACompromise | - affiliationChanged | superseded | cessationOfOperation | - certificateHold | privilegeWithdrawn | - aACompromise -

+ + time() +

= uct_time() | general_time()

 + + uct_time() +

= {utcTime, "YYMMDDHHMMSSZ"}

 + + general_time() +

= {generalTime, "YYYYMMDDHHMMSSZ"}

 + + general_name() + =

{rfc822Name, string()}

+

| {dNSName, string()}

+

| {x400Address, string()}

+

| {directoryName, {rdnSequence, [#AttributeTypeAndValue'{}]}}

+

| {eidPartyName, special_string()}

+

| {eidPartyName, special_string(), special_string()}

+

| {uniformResourceIdentifier, string()}

+

| {ipAddress, string()}

+

| {registeredId, oid()}

+

| {otherName, term()}

+ + + special_string() + =

{teletexString, string()}

+

| {printableString, string()}

+

| {universalString, string()}

+

| {utf8String, binary()}

+

| {bmpString, string()}

+ + + dist_reason() + =

unused

+

| keyCompromise

+

| cACompromise

+

| affiliationChanged

+

| superseded

+

| cessationOfOperation

+

| certificateHold

+

| privilegeWithdrawn

+

| aACompromise

+ + +
- PKIX Certificates + PKIX Certificates +

Erlang representation of PKIX certificates derived from ASN.1 + specifications and RFC 5280 are as follows:

#'Certificate'{ tbsCertificate, % #'TBSCertificate'{} @@ -117,8 +132,7 @@ semantics, please see + }. #'OTPCertificate'{ @@ -143,20 +157,20 @@ semantics, please see + }. -

id_signature_algorithm() = ?oid_name_as_erlang_atom for available -oid names see table below. Ex: ?'id-dsa-with-sha1'

+

Here, id_signature_algorithm() = ?OID name, for available OID names, for example +?id-dsa-with-sha1. That is, by prepending "?" to the OID name, represented as an Erlang atom.

+

The available OID names are as follows:

- OID name + OID Name id-dsa-with-sha1 - id-dsaWithSHA1 (ISO alt oid to above) + id-dsaWithSHA1 (ISO or OID to above) md2WithRSAEncryption @@ -168,7 +182,7 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

sha1WithRSAEncryption - sha-1WithRSAEncryption (ISO alt oid to above) + sha-1WithRSAEncryption (ISO or OID to above) sha224WithRSAEncryption @@ -182,21 +196,24 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

ecdsa-with-SHA1 - Signature algorithm oids + Signature Algorithm OIDs
+

The data type 'AttributeTypeAndValue', is represented as + the following erlang record:

+ #'AttributeTypeAndValue'{ type, % id_attributes() value % term() - }. - + }. -

id_attributes()

+

The attribute OID name atoms and their corresponding value types +are as follows:

- OID name - Value type + OID Name + Value Type id-at-name @@ -254,9 +271,12 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

id-at-pseudonym special_string() - Attribute oids + Attribute OIDs
+

The data types 'Validity', 'SubjectPublicKeyInfo', and +'SubjectPublicKeyInfoAlgorithm' are represented as the following Erlang records:

+ #'Validity'{ notBefore, % time() @@ -271,13 +291,12 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

#'SubjectPublicKeyInfoAlgorithm'{ algorithm, % id_public_key_algorithm() parameters % public_key_params() - }. - + }. -

id_public_key_algorithm()

+

The public-key algorithm OID name atoms are as follows:

- OID name + OID Name rsaEncryption @@ -294,7 +313,7 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

id-ecPublicKey - Public key algorithm oids + Public-Key Algorithm OIDs
@@ -302,8 +321,7 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

extnID, % id_extensions() | oid() critical, % boolean() extnValue % der_encoded() - }. - + }.

id_extensions() Standard Certificate Extensions, @@ -316,12 +334,15 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

- Standard certificate extensions - + Standard Certificate Extensions + +

The standard certificate extensions OID name atoms and their + corresponding value types are as follows:

+ - OID name - Value type + OID Name + Value Type id-ce-authorityKeyIdentifier @@ -333,7 +354,7 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

 id-ce-keyUsage - [key_usage()] + [key_usage()] id-ce-privateKeyUsagePeriod @@ -400,17 +421,26 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

Standard Certificate Extensions
-

- key_usage() = digitalSignature | nonRepudiation | keyEncipherment| - dataEncipherment | keyAgreement | keyCertSign | cRLSign | encipherOnly | - decipherOnly -

+

Here:

+ + key_usage() + =

digitalSignature

+

| nonRepudiation

+

| keyEncipherment

+

| dataEncipherment

+

| keyAgreement

+

| keyCertSign

+

| cRLSign

+

| encipherOnly

+

| decipherOnly

+ + -

id_key_purpose()

+

And for id_key_purpose():

- OID name + OID Name id-kp-serverAuth @@ -430,7 +460,7 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

id-kp-OCSPSigning - Key purpose oids + Key Purpose OIDs
@@ -501,8 +531,7 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

[#AttributeTypeAndValue{}]} reasons, % [dist_reason()] cRLIssuer % [general_name()] - }). - + }).
@@ -510,10 +539,13 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

Private Internet Extensions +

The private internet extensions OID name atoms and their corresponding value + types are as follows:

+ - OID name - Value type + OID Name + Value Type id-pe-authorityInfoAccess @@ -530,13 +562,15 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

#'AccessDescription'{ accessMethod, % oid() accessLocation % general_name() - }). - + }).
- CRL and CRL Extensions Profile + CRL and CRL Extensions Profile + +

Erlang representation of CRL and CRL extensions profile + derived from ASN.1 specifications and RFC 5280 are as follows:

#'CertificateList'{ @@ -559,17 +593,19 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

userCertificate, % integer() revocationDate, % timer() crlEntryExtensions % [#'Extension'{}] - }). - + }).
- CRL Extensions + CRL Extensions + +

The CRL extensions OID name atoms and their corresponding value types are as follows:

+
- OID name - Value type + OID Name + Value Type id-ce-authorityKeyIdentifier @@ -599,6 +635,9 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

CRL Extensions
+

Here, the data type 'IssuingDistributionPoint' is represented as + the following Erlang record:

+ #'IssuingDistributionPoint'{ distributionPoint, % {fullName, [general_name()]} | {nameRelativeToCRLIssuer, @@ -608,18 +647,19 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

onlySomeReasons, % [dist_reason()] indirectCRL, % boolean() onlyContainsAttributeCerts % boolean() - }). - + }).
- CRL Entry Extensions + CRL Entry Extensions + +

The CRL entry extensions OID name atoms and their corresponding value types are as follows:

- OID name - Value type + OID Name + Value Type id-ce-cRLReason @@ -639,17 +679,31 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

CRL Entry Extensions
-

- crl_reason() = unspecified | keyCompromise | cACompromise | - affiliationChanged | superseded | cessationOfOperation | - certificateHold | removeFromCRL | privilegeWithdrawn | - aACompromise -

+ + +

Here:

+ + crl_reason() + =

unspecifiedc>

+

| keyCompromise

+

| cACompromise

+

| affiliationChanged

+

| superseded

+

| cessationOfOperation

+

| certificateHold

+

| removeFromCRL

+

| privilegeWithdrawn

+

| aACompromise

+ + +
PKCS#10 Certification Request +

Erlang representation of a PKCS#10 certification request + derived from ASN.1 specifications and RFC 5280 are as follows:

#'CertificationRequest'{ certificationRequestInfo #'CertificationRequestInfo'{}, @@ -682,8 +736,7 @@ oid names see table below. Ex: ?'id-dsa-with-sha1'

#'AttributePKCS-10'{ type = oid(), values = [der_encoded()] -} - +}
diff --git a/lib/public_key/doc/src/introduction.xml b/lib/public_key/doc/src/introduction.xml index bf11a092d8..17f4e5155a 100644 --- a/lib/public_key/doc/src/introduction.xml +++ b/lib/public_key/doc/src/introduction.xml @@ -36,27 +36,28 @@
Purpose -

public_key deals with public key related file formats, digital - signatures and +

The public_key application deals with public-key related file + formats, digital signatures, and X-509 certificates. It is a library application that - provides encode/decode, sign/verify, encrypt/decrypt and similar - functionality, it does not read or write files it expects or returns + provides encode/decode, sign/verify, encrypt/decrypt, and similar + functionality. It does not read or write files, it expects or returns file contents or partial file contents as binaries.

Prerequisites -

It is assumed that the reader has a basic understanding - of the concepts of using public keys and digital certificates.

+

It is assumed that the reader is familiar with the Erlang programming + language and has a basic understanding of the concepts of using public-keys + and digital certificates.

- Performance tips -

The public_key decode and encode functions will try to use the NIFs - which are in the ASN1 compilers runtime modules if they can be found. - So for the best performance you want to have the ASN1 application in the - path of your system.

+ Performance Tips +

The public_key decode- and encode-functions try to use the NIFs + in the ASN.1 compilers runtime modules, if they can be found. + Thus, to have the ASN.1 application in the + path of your system gives the best performance.

diff --git a/lib/public_key/doc/src/part.xml b/lib/public_key/doc/src/part.xml index 73146c8e2a..d3cc9303bd 100644 --- a/lib/public_key/doc/src/part.xml +++ b/lib/public_key/doc/src/part.xml @@ -31,15 +31,14 @@ part.xml -

This application provides an API to public key infrastructure +

This application provides an API to public-key infrastructure from RFC - 5280 (X.509 certificates) and public key formats defined by + 5280 (X.509 certificates) and public-key formats defined by the - PKCS-standard

+ PKCS standard.

 - - + diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index b86d0fe0ab..ddaa8c2530 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -31,11 +31,11 @@ public_key - API module for public key infrastructure. + API module for public-key infrastructure. -

This module provides functions to handle public key infrastructure. It can - encode/decode different file formats (PEM, openssh), sign and verify digital signatures and validate - certificate paths and certificate revocation lists. +

This module provides functions to handle public-key infrastructure. It can + encode/decode different file formats (PEM, OpenSSH), sign and verify digital signatures, + and validate certificate paths and certificate revocation lists.

@@ -43,94 +43,152 @@ public_key - public_key requires the crypto and asn1 applications, the latter since R16 (hopefully the runtime dependency on asn1 will - be removed again in the future). + public_key requires the crypto and ASN.1 applications, + the latter as OTP R16 (hopefully the runtime dependency on ASN.1 will + be removed again in the future). Supports RFC 5280 - - Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile - Supports PKCS-1 - RSA Cryptography Standard - Supports DSS- Digital Signature Standard (DSA - Digital Signature Algorithm) - Supports PKCS-3 - Diffie-Hellman Key Agreement Standard - Supports PKCS-5 - Password-Based Cryptography Standard - Supports PKCS-8 - Private-Key Information Syntax Standard - Supports PKCS-10 - Certification Request Syntax Standard + Internet X.509 Public-Key Infrastructure Certificate and Certificate Revocation List + (CRL) Profile + Supports PKCS-1 - + RSA Cryptography Standard + Supports DSS - + Digital Signature Standard (DSA - Digital Signature Algorithm) + Supports + PKCS-3 - + Diffie-Hellman Key Agreement Standard + Supports PKCS-5 - + Password-Based Cryptography Standard + Supports PKCS-8 - + Private-Key Information Syntax Standard + Supports PKCS-10 - + Certification Request Syntax Standard
- COMMON DATA TYPES + DATA TYPES -

All records used in this manual +

All records used in this Reference Manual are generated from ASN.1 specifications and are documented in the User's Guide. See Public key records and X.509 Certificate records. + marker="public_key_records">Public-key Records and X.509 Certificate Records.

Use the following include directive to get access to the - records and constant macros described here and in the User's Guide.

+ records and constant macros described here and in the User's Guide:

-include_lib("public_key/include/public_key.hrl"). -

Data Types

- -

oid() - Object Identifier, a tuple of integers as generated by the ASN1 compiler.

- -

boolean() = true | false

- -

string() = [bytes()]

- -

der_encoded() = binary()

- -

pki_asn1_type() = 'Certificate' | 'RSAPrivateKey'| 'RSAPublicKey' | - 'DSAPrivateKey' | 'DSAPublicKey' | 'DHParameter' | - 'SubjectPublicKeyInfo' | 'PrivateKeyInfo' | - 'CertificationRequest' | 'ECPrivateKey' | 'EcpkParameters'

- -

pem_entry () = {pki_asn1_type(), binary(), %% DER or encrypted DER - not_encrypted | cipher_info()}

- -

cipher_info() = {"RC2-CBC | "DES-CBC" | "DES-EDE3-CBC", - crypto:rand_bytes(8) | {#'PBEParameter{}, digest_type()} |#'PBES2-params'{}}

- -

public_key() = rsa_public_key() | dsa_public_key() | ec_public_key()

-

private_key() = rsa_private_key() | dsa_private_key() | ec_private_key()

-

rsa_public_key() = #'RSAPublicKey'{}

- -

rsa_private_key() = #'RSAPrivateKey'{}

- -

dsa_public_key() = {integer(), #'Dss-Parms'{}}

- -

dsa_private_key() = #'DSAPrivateKey'{}

- -

ec_public_key() = {#'ECPoint'{}, #'EcpkParameters'{} | - {namedCurve, oid()}}

- -

ec_private_key() = #'ECPrivateKey'{}

- -

public_crypt_options() = [{rsa_pad, rsa_padding()}].

- -

rsa_padding() = 'rsa_pkcs1_padding' | 'rsa_pkcs1_oaep_padding' | - 'rsa_no_padding'

+

The following data types are used in the functions for public_key:

-

digest_type() - Union of below digest types

+ + oid() +

Object identifier, a tuple of integers as generated by the ASN.1 compiler.

 + + boolean() +

= true | false

 + + string() +

= [bytes()]

 + + der_encoded() +

= binary()

 + + pki_asn1_type() + =

'Certificate'

+

| 'RSAPrivateKey'

+

| 'RSAPublicKey'

+

| 'DSAPrivateKey'

+

| 'DSAPublicKey'

+

| 'DHParameter'

+

| 'SubjectPublicKeyInfo'

+

| 'PrivateKeyInfo'

+

| 'CertificationRequest'

+

| 'ECPrivateKey'

+

| 'EcpkParameters'

 + + pem_entry () +

= {pki_asn1_type(), binary(), %% DER or encrypted DER not_encrypted

+

| cipher_info()}

 + + cipher_info() +

= {"RC2-CBC" | "DES-CBC" | "DES-EDE3-CBC", crypto:rand_bytes(8)

+

| {#'PBEParameter{}, digest_type()} | #'PBES2-params'{}}

+ + + public_key() +

= rsa_public_key() | dsa_public_key() | ec_public_key()

 + + private_key() +

= rsa_private_key() | dsa_private_key() | ec_private_key()

 + + rsa_public_key() +

= #'RSAPublicKey'{}

 + + rsa_private_key() +

= #'RSAPrivateKey'{}

 + + dsa_public_key() +

= {integer(), #'Dss-Parms'{}}

 + + dsa_private_key() +

= #'DSAPrivateKey'{}

 + + ec_public_key() +

= {#'ECPoint'{}, #'EcpkParameters'{} | {namedCurve, oid()}}

 + + ec_private_key() +

= #'ECPrivateKey'{}

 + + public_crypt_options() +

= [{rsa_pad, rsa_padding()}]

 + + rsa_padding() +

= 'rsa_pkcs1_padding'

+

| 'rsa_pkcs1_oaep_padding'

+

| 'rsa_no_padding'

+ + + digest_type() +

Union of rsa_digest_type(), dss_digest_type(), + and ecdsa_digest_type().

 + + rsa_digest_type() +

= 'md5' | 'sha' | 'sha224' | 'sha256' | 'sha384' | 'sha512'

 + + dss_digest_type() +

= 'sha'

 + + ecdsa_digest_type() +

= 'sha'| 'sha224' | 'sha256' | 'sha384' | 'sha512'

 + + crl_reason() +

= unspecified

+

| keyCompromise

+

| cACompromise

+

| affiliationChanged

+

| superseded

+

| cessationOfOperation

+

| certificateHold

+

| privilegeWithdrawn

+

| aACompromise

+ + + issuer_name() +

= {rdnSequence,[#'AttributeTypeAndValue'{}]}

+ + + ssh_file() +

= openssh_public_key

+

| rfc4716_public_key

+

| known_hosts

+

| auth_keys

+ + -

rsa_digest_type() = 'md5' | 'sha' | 'sha224' | 'sha256' | 'sha384' | - 'sha512'

- -

dss_digest_type() = 'sha'

- -

ecdsa_digest_type() = 'sha'| 'sha224' | 'sha256' | 'sha384' | 'sha512'

- -

crl_reason() = unspecified | keyCompromise | cACompromise | - affiliationChanged | superseded | cessationOfOperation | - certificateHold | privilegeWithdrawn | aACompromise

- -

issuer_name() = {rdnSequence,[#'AttributeTypeAndValue'{}]}

- -

ssh_file() = openssh_public_key | rfc4716_public_key | known_hosts | - auth_keys

@@ -138,12 +196,12 @@ - + - + @@ -151,13 +209,13 @@ - + - + - - + +
@@ -166,27 +224,27 @@ compute_key(OthersKey, MyKey)-> compute_key(OthersKey, MyKey, Params)-> - Compute shared secret + Computes shared secret. OthersKey = #'ECPoint'{} | binary(), MyKey = #'ECPrivateKey'{} | binary() Params = #'DHParameter'{} -

Compute shared secret

+

Computes shared secret.

 decrypt_private(CipherText, Key) -> binary() decrypt_private(CipherText, Key, Options) -> binary() - Public key decryption. + Public-key decryption. CipherText = binary() Key = rsa_private_key() Options = public_crypt_options() -

Public key decryption using the private key. See also Public-key decryption using the private key. See also crypto:private_decrypt/4

 @@ -194,156 +252,156 @@ decrypt_public(CipherText, Key) - > binary() decrypt_public(CipherText, Key, Options) - > binary() - + Public-key decryption. CipherText = binary() Key = rsa_public_key() Options = public_crypt_options() -

Public key decryption using the public key. See also Public-key decryption using the public key. See also crypto:public_decrypt/4

 der_decode(Asn1type, Der) -> term() - Decodes a public key ASN.1 DER encoded entity. + Decodes a public-key ASN.1 DER encoded entity. Asn1Type = atom() - ASN.1 type present in the public_key applications - asn1 specifications. + ASN.1 type present in the public_key applications + ASN.1 specifications. Der = der_encoded() -

Decodes a public key ASN.1 DER encoded entity.

+

Decodes a public-key ASN.1 DER encoded entity.

 der_encode(Asn1Type, Entity) -> der_encoded() - Encodes a public key entity with asn1 DER encoding. + Encodes a public-key entity with ASN.1 DER encoding. Asn1Type = atom() - Asn1 type present in the public_key applications + ASN.1 type present in the public_key applications ASN.1 specifications. Entity = term() - The erlang representation of Asn1Type + Erlang representation of Asn1Type -

Encodes a public key entity with ASN.1 DER encoding.

+

Encodes a public-key entity with ASN.1 DER encoding.

 generate_key(Params) -> {Public::binary(), Private::binary()} | #'ECPrivateKey'{} - Generates a new keypair + Generates a new keypair. - Params = #'DHParameter'{} | {namedCurve, oid()} | #'ECParameters'{} + Params = #'DHParameter'{} | {namedCurve, oid()} | #'ECParameters'{} -

Generates a new keypair

+

Generates a new keypair.

 pem_decode(PemBin) -> [pem_entry()] - Decode PEM binary data and return - entries as ASN.1 DER encoded entities. + Decodes PEM binary data and returns + entries as ASN.1 DER encoded entities. PemBin = binary() Example {ok, PemBin} = file:read_file("cert.pem"). -

Decode PEM binary data and return +

Decodes PEM binary data and returns entries as ASN.1 DER encoded entities.

 pem_encode(PemEntries) -> binary() - Creates a PEM binary + Creates a PEM binary. PemEntries = [pem_entry()] -

Creates a PEM binary

+

Creates a PEM binary.

 pem_entry_decode(PemEntry) -> term() pem_entry_decode(PemEntry, Password) -> term() - Decodes a pem entry. + Decodes a PEM entry. - PemEntry = pem_entry() - Password = string() + PemEntry = pem_entry() + Password = string() -

Decodes a PEM entry. pem_decode/1 returns a list of PEM - entries. Note that if the PEM entry is of type - 'SubjectPublickeyInfo' it will be further decoded to an - rsa_public_key() or dsa_public_key().

+

Decodes a PEM entry. pem_decode/1 returns a list of PEM + entries. Notice that if the PEM entry is of type + 'SubjectPublickeyInfo', it is further decoded to an + rsa_public_key() or dsa_public_key().

 pem_entry_encode(Asn1Type, Entity) -> pem_entry() pem_entry_encode(Asn1Type, Entity, {CipherInfo, Password}) -> pem_entry() - Creates a PEM entry that can be fed to pem_encode/1. + Creates a PEM entry that can be fed to pem_encode/1. Asn1Type = pki_asn1_type() Entity = term() - The Erlang representation of - Asn1Type. If Asn1Type is 'SubjectPublicKeyInfo' - then Entity must be either an rsa_public_key() or a - dsa_public_key() and this function will create the appropriate + Erlang representation of + Asn1Type. If Asn1Type is 'SubjectPublicKeyInfo', + Entity must be either an rsa_public_key() or a + dsa_public_key() and this function creates the appropriate 'SubjectPublicKeyInfo' entry. CipherInfo = cipher_info() Password = string() -

Creates a PEM entry that can be feed to pem_encode/1.

+

Creates a PEM entry that can be feed to pem_encode/1.

 encrypt_private(PlainText, Key) -> binary() - Public key encryption using the private key. + Public-key encryption using the private key. PlainText = binary() Key = rsa_private_key() -

Public key encryption using the private key. +

Public-key encryption using the private key. See also crypto:private_encrypt/4

+ marker="crypto:crypto#private_encrypt/4">crypto:private_encrypt/4.

 encrypt_public(PlainText, Key) -> binary() - Public key encryption using the public key. + Public-key encryption using the public key. PlainText = binary() Key = rsa_public_key() -

Public key encryption using the public key. See also crypto:public_encrypt/4

+

Public-key encryption using the public key. See also crypto:public_encrypt/4.

 pkix_decode_cert(Cert, otp|plain) -> #'Certificate'{} | #'OTPCertificate'{} - Decodes an ASN.1 DER encoded PKIX x509 certificate. + Decodes an ASN.1 DER-encoded PKIX x509 certificate. Cert = der_encoded() -

Decodes an ASN.1 DER encoded PKIX certificate. The otp option - will use the customized ASN.1 specification OTP-PKIX.asn1 for +

Decodes an ASN.1 DER-encoded PKIX certificate. Option otp + uses the customized ASN.1 specification OTP-PKIX.asn1 for decoding and also recursively decode most of the standard parts.

 @@ -355,54 +413,54 @@ certificate. Asn1Type = atom() - The ASN.1 type can be 'Certificate', 'OTPCertificate' or a subtype of either . + The ASN.1 type can be 'Certificate', 'OTPCertificate' or a subtype of either. Entity = #'Certificate'{} | #'OTPCertificate'{} | a valid subtype

DER encodes a PKIX x509 certificate or part of such a certificate. This function must be used for encoding certificates or parts of certificates - that are decoded/created in the otp format, whereas for the plain format this - function will directly call der_encode/2.

+ that are decoded/created in the otp format, whereas for the plain format this + function directly calls der_encode/2.

 pkix_is_issuer(Cert, IssuerCert) -> boolean() - Checks if IssuerCert issued Cert + Checks if IssuerCert issued Cert. Cert = der_encoded() | #'OTPCertificate'{} IssuerCert = der_encoded() | #'OTPCertificate'{} -

Checks if IssuerCert issued Cert

+

Checks if IssuerCert issued Cert.

 pkix_is_fixed_dh_cert(Cert) -> boolean() - Checks if a Certificate is a fixed Diffie-Hellman Cert. + Checks if a certificate is a fixed Diffie-Hellman certificate. Cert = der_encoded() | #'OTPCertificate'{} -

Checks if a Certificate is a fixed Diffie-Hellman Cert.

+

Checks if a certificate is a fixed Diffie-Hellman certificate.

 pkix_is_self_signed(Cert) -> boolean() - Checks if a Certificate is self signed. + Checks if a certificate is self-signed. Cert = der_encoded() | #'OTPCertificate'{} -

Checks if a Certificate is self signed.

+

Checks if a certificate is self-signed.

 pkix_issuer_id(Cert, IssuedBy) -> {ok, IssuerID} | {error, Reason} - Returns the issuer id. + Returns the issuer id. Cert = der_encoded() | #'OTPCertificate'{} IssuedBy = self | other @@ -411,43 +469,43 @@ Reason = term() -

Returns the issuer id.

+

Returns the issuer id.

 pkix_normalize_name(Issuer) -> Normalized - Normalizes a issuer name so that it can be easily - compared to another issuer name. + Normalizes an issuer name so that it can be easily + compared to another issuer name. Issuer = issuer_name() Normalized = issuer_name() -

Normalizes a issuer name so that it can be easily +

Normalizes an issuer name so that it can be easily compared to another issuer name.

 pkix_path_validation(TrustedCert, CertChain, Options) -> {ok, {PublicKeyInfo, PolicyTree}} | {error, {bad_cert, Reason}} - Performs a basic path validation according to RFC 5280. + Performs a basic path validation according to RFC 5280. - TrustedCert = #'OTPCertificate'{} | der_encoded() | atom() - Normally a trusted certificate but it can also be a path validation + TrustedCert = #'OTPCertificate'{} | der_encode() | atom() + Normally a trusted certificate, but it can also be a path-validation error that can be discovered while - constructing the input to this function and that should be run through the verify_fun. - For example unknown_ca or selfsigned_peer + constructing the input to this function and that is to be run through the verify_fun. + Examples are unknown_ca and selfsigned_peer. - CertChain = [der_encoded()] - A list of DER encoded certificates in trust order ending with the peer certificate. - Options = proplists:proplist() + CertChain = [der_encode()] + A list of DER-encoded certificates in trust order ending with the peer certificate. + Options = proplists:proplist() PublicKeyInfo = {?'rsaEncryption' | ?'id-dsa', rsa_public_key() | integer(), 'NULL' | 'Dss-Parms'{}} - PolicyTree = term() - At the moment this will always be an empty list as Policies are not currently supported - Reason = cert_expired | invalid_issuer | invalid_signature | name_not_permitted | + PolicyTree = term() + At the moment this is always an empty list as policies are not currently supported. + Reason = cert_expired | invalid_issuer | invalid_signature | name_not_permitted | missing_basic_constraint | invalid_key_usage | {revoked, crl_reason()} | atom() @@ -455,17 +513,17 @@

Performs a basic path validation according to RFC 5280. - However CRL validation is done separately by pkix_crls_validate/3 and should be called - from the supplied verify_fun + However, CRL validation is done separately by pkix_crls_validate/3 and is to be called + from the supplied verify_fun.

- -

Available options are:

+

Available options:

+ {verify_fun, fun()} -

The fun should be defined as:

+

The fun must be defined as:

fun(OtpCert :: #'OTPCertificate'{}, @@ -478,53 +536,53 @@ fun(OtpCert :: #'OTPCertificate'{}, {unknown, UserState :: term()}. -

If the verify callback fun returns {fail, Reason}, the +

If the verify callback fun returns {fail, Reason}, the verification process is immediately stopped. If the verify - callback fun returns {valid, UserState}, the verification - process is continued, this can be used to accept specific path - validation errors such as selfsigned_peer as well as - verifying application specific extensions. If called with an - extension unknown to the user application the return value - {unknown, UserState} should be used.

+ callback fun returns {valid, UserState}, the verification + process is continued. This can be used to accept specific path + validation errors, such as selfsigned_peer, as well as + verifying application-specific extensions. If called with an + extension unknown to the user application, the return value + {unknown, UserState} is to be used.

 {max_path_length, integer()} The max_path_length is the maximum number of non-self-issued - intermediate certificates that may follow the peer certificate - in a valid certification path. So if max_path_length is 0 the PEER must - be signed by the trusted ROOT-CA directly, if 1 the path can - be PEER, CA, ROOT-CA, if it is 2 PEER, CA, CA, ROOT-CA and so - on. + intermediate certificates that can follow the peer certificate + in a valid certification path. So, if max_path_length is 0, the PEER must + be signed by the trusted ROOT-CA directly, if it is 1, the path can + be PEER, CA, ROOT-CA, if it is 2, the path can + be PEER, CA, CA, ROOT-CA, and so on. -

Possible reasons for a bad certificate are:

+

Possible reasons for a bad certificate:

cert_expired - The certificate is no longer valid as its expiration date has passed. +

Certificate is no longer valid as its expiration date has passed.

 invalid_issuer - The certificate issuer name does not match the name of the issuer certificate in the chain. +

Certificate issuer name does not match the name of the issuer certificate in the chain.

 invalid_signature - The certificate was not signed by its issuer certificate in the chain. +

Certificate was not signed by its issuer certificate in the chain.

 name_not_permitted - Invalid Subject Alternative Name extension. +

Invalid Subject Alternative Name extension.

 missing_basic_constraint - Certificate, required to have the basic constraints extension, does not have - a basic constraints extension. +

Certificate, required to have the basic constraints extension, does not have + a basic constraints extension.

 invalid_key_usage - Certificate key is used in an invalid way according to the key usage extension. +

Certificate key is used in an invalid way according to the key-usage extension.

 {revoked, crl_reason()} - Certificate has been revoked. +

Certificate has been revoked.

 atom() - Application specific error reason that should be checked by the verify_fun +

Application-specific error reason that is to be checked by the verify_fun.

 @@ -543,44 +601,47 @@ fun(OtpCert :: #'OTPCertificate'{}, pkix_crls_validate(OTPCertificate, DPAndCRLs, Options) -> CRLStatus() - Performs CRL validation. + Performs CRL validation. - OTPCertificate = #'OTPCertificate'{} - DPAndCRLs = [{DP::#'DistributionPoint'{}, {DerCRL::der_encoded(), CRL::#'CertificateList'{}}}] - Options = proplists:proplist() - CRLStatus() = valid | {bad_cert, revocation_status_undetermined} | + OTPCertificate = #'OTPCertificate'{} + DPAndCRLs = [{DP::#'DistributionPoint'{}, {DerCRL::der_encoded(), CRL::#'CertificateList'{}}}] + Options = proplists:proplist() + CRLStatus() = valid | {bad_cert, revocation_status_undetermined} | {bad_cert, {revoked, crl_reason()}} -

Performs CRL validation. It is intended to be called from +

Performs CRL validation. It is intended to be called from the verify fun of pkix_path_validation/3 -

+ .

+ +

Available options:

+ -

Available options are:

+ {update_crl, fun()} -

The fun has the following type spec:

+

The fun has the following type specification:

fun(#'DistributionPoint'{}, #'CertificateList'{}) -> #'CertificateList'{} -

The fun should use the information in the distribution point to acesses - the lates possible version of the CRL. If this fun is not specified - public_key will use the default implementation: +

The fun uses the information in the distribution point to access + the latest possible version of the CRL. If this fun is not specified, + public_key uses the default implementation:

fun(_DP, CRL) -> CRL end {issuer_fun, fun()} -

The fun has the following type spec:

+

The fun has the following type specification:

fun(#'DistributionPoint'{}, #'CertificateList'{}, {rdnSequence,[#'AttributeTypeAndValue'{}]}, term()) -> {ok, #'OTPCertificate'{}, [der_encoded]} -

The fun should return the root certificate and certificate chain +

The fun returns the root certificate and certificate chain that has signed the CRL.

fun(DP, CRL, Issuer, UserState) -> {ok, RootCert, CertChain} @@ -635,83 +696,83 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, Key = rsa_public_key() | dsa_public_key() -

Signs a 'OTPTBSCertificate'. Returns the corresponding - der encoded certificate.

+

Signs an 'OTPTBSCertificate'. Returns the corresponding + DER-encoded certificate.

 pkix_sign_types(AlgorithmId) -> {DigestType, SignatureType} - Translates signature algorithm oid to erlang digest and signature algorithm types. + Translates signature algorithm OID to Erlang digest and signature algorithm types. AlgorithmId = oid() - Signature oid from a certificate or a certificate revocation list - DigestType = rsa_digest_type() | dss_digest_type() + Signature OID from a certificate or a certificate revocation list. + DigestType = rsa_digest_type() | dss_digest_type() SignatureType = rsa | dsa -

Translates signature algorithm oid to erlang digest and signature types. +

Translates signature algorithm OID to Erlang digest and signature types.

pkix_verify(Cert, Key) -> boolean() - Verify pkix x.509 certificate signature. + Verifies PKIX x.509 certificate signature. Cert = der_encoded() Key = rsa_public_key() | dsa_public_key() -

Verify PKIX x.509 certificate signature.

+

Verifies PKIX x.509 certificate signature.

 sign(Msg, DigestType, Key) -> binary() - Create digital signature. + Creates a digital signature. Msg = binary() | {digest,binary()} - The msg is either the binary "plain text" data to be - signed or it is the hashed value of "plain text" i.e. the + The Msg is either the binary "plain text" data to be + signed or it is the hashed value of "plain text", that is, the digest. DigestType = rsa_digest_type() | dss_digest_type() | ecdsa_digest_type() Key = rsa_private_key() | dsa_private_key() | ec_private_key() -

Creates a digital signature.

+

Creates a digital signature.

 ssh_decode(SshBin, Type) -> [{public_key(), Attributes::list()}] - Decodes a ssh file-binary. + Decodes an SSH file-binary. SshBin = binary() Example {ok, SshBin} = file:read_file("known_hosts"). - Type = public_key | ssh_file() - If Type is public_key the binary may be either - a rfc4716 public key or a openssh public key. + Type = public_key | ssh_file() + If Type is public_key the binary can be either + an RFC4716 public key or an OpenSSH public key. -

Decodes a ssh file-binary. In the case of know_hosts or - auth_keys the binary may include one or more lines of the +

Decodes an SSH file-binary. In the case of know_hosts or + auth_keys, the binary can include one or more lines of the file. Returns a list of public keys and their attributes, possible attribute values depends on the file type represented by the binary.

- rfc4716 attributes - see RFC 4716 - {headers, [{string(), utf8_string()}]} - auth_key attributes - see man sshd + RFC4716 attributes - see RFC 4716. +

{headers, [{string(), utf8_string()}]}

 + auth_key attributes - see manual page for sshd. {comment, string()} {options, [string()]} - {bits, integer()} - In ssh version 1 files - known_host attributes - see man sshd +

{bits, integer()} - In SSH version 1 files.

 + known_host attributes - see manual page for sshd. {hostnames, [string()]} {comment, string()} - {bits, integer()} - In ssh version 1 files +

{bits, integer()} - In SSH version 1 files.

 @@ -719,16 +780,16 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, ssh_encode([{Key, Attributes}], Type) -> binary() - Encodes a list of ssh file entries to a binary. + Encodes a list of SSH file entries to a binary. Key = public_key() Attributes = list() Type = ssh_file() -

Encodes a list of ssh file entries (public keys and attributes) to a binary. Possible - attributes depends on the file type, see ssh_decode/2

+

Encodes a list of SSH file entries (public keys and attributes) to a binary. Possible + attributes depend on the file type, see ssh_decode/2 .

 @@ -737,14 +798,14 @@ fun(#'DistributionPoint'{}, #'CertificateList'{}, Verifies a digital signature. Msg = binary() | {digest,binary()} - The msg is either the binary "plain text" data - or it is the hashed value of "plain text" i.e. the digest. + The Msg is either the binary "plain text" data + or it is the hashed value of "plain text", that is, the digest. DigestType = rsa_digest_type() | dss_digest_type() | ecdsa_digest_type() Signature = binary() Key = rsa_public_key() | dsa_public_key() | ec_public_key() -

Verifies a digital signature

+

Veryfies a digital signature.

 diff --git a/lib/public_key/doc/src/public_key_records.xml b/lib/public_key/doc/src/public_key_records.xml index a7dfc41449..24f5faf38e 100644 --- a/lib/public_key/doc/src/public_key_records.xml +++ b/lib/public_key/doc/src/public_key_records.xml @@ -23,7 +23,7 @@ The Initial Developer of the Original Code is Ericsson AB. - Public key records + Public-Key Records Ingela Anderton Andin @@ -34,14 +34,14 @@ public_key_records.xml -

This chapter briefly describes Erlang records derived from ASN1 +

This section briefly describes Erlang records derived from ASN.1 specifications used to handle public and private keys. - The intent is to describe the data types - and not to specify the semantics of each component. For information on the - semantics, please see the relevant standards and RFCs.

+ The scope is to describe the data types of each component, + not the semantics. For information on the + semantics, refer to the relevant standards and RFCs.

Use the following include directive to get access to the - records and constant macros described in the following sections.

+ records and constant macros described in the following sections:

-include_lib("public_key/include/public_key.hrl"). @@ -49,13 +49,15 @@ Common Data Types

Common non-standard Erlang - data types used to described the record fields in the - below sections are defined in public key reference manual

+ data types used to describe the record fields in the + following sections are defined in the public_key Reference Manual.

- RSA as defined by the PKCS-1 standard and <url href="http://www.ietf.org/rfc/rfc3447.txt"> RFC 3447 </url> + The RSA According to PKCS-1 and RFC 3447 +

RSA as defined by the PKCS-1 standard and + RFC 3447 follows:

#'RSAPublicKey'{ @@ -80,15 +82,15 @@ prime, % integer() exponent, % integer() coefficient % integer() - }. - + }.
- DSA as defined by - <url href="http://csrc.nist.gov/publications/fips/fips186-3/fips_186-3.pdf"> Digital Signature Standard (NIST FIPS PUB 186-2) </url> - + DSA According to DSS +

The DSA as defined by the + + Digital Signature Standard (DSS), NIST FIPS PUB 186-2 follows:

#'DSAPrivateKey',{ @@ -104,13 +106,13 @@ p, % integer() q, % integer() g % integer() - }. - + }.
- ECC (Elliptic Curve) <url href="http://www.ietf.org/rfc/rfc3447.txt"> RFC 5480 </url> - + ECC According to RFC 5480 +

The Elliptic Curve (ECC) as defined by + RFC 5480 follows:

#'ECPrivateKey'{ diff --git a/lib/public_key/doc/src/records.xml b/lib/public_key/doc/src/records.xml new file mode 100644 index 0000000000..75265791af --- /dev/null +++ b/lib/public_key/doc/src/records.xml @@ -0,0 +1,47 @@ + + + + +
+ + 2008 + 2014 + Ericsson AB, All Rights Reserved + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + The Initial Developer of the Original Code is Ericsson AB. + + + Records + Tommy MÃ¥nevik + + 2015-04-01 + + records.xml +
+ +

This section describes Erlang records derived from ASN.1 specifications, + used to handle the following: +

+ + Public and private keys + X509 certificates and CertificationRequest + + + + + + + + diff --git a/lib/public_key/doc/src/ref_man.xml b/lib/public_key/doc/src/ref_man.xml index b7078891d4..9c80cf4b9f 100644 --- a/lib/public_key/doc/src/ref_man.xml +++ b/lib/public_key/doc/src/ref_man.xml @@ -31,8 +31,8 @@ ref_man.xml -

Provides functions to handle public key infrastructure - from RFC 3280 (X.509 certificates) and some parts of the PKCS-standard. +

The public_key application provides functions to handle public-key infrastructure + from RFC 3280 (X.509 certificates) and parts of the PKCS standard.

diff --git a/lib/public_key/doc/src/using_public_key.xml b/lib/public_key/doc/src/using_public_key.xml index 450bd7e35f..69b8c0dcb9 100644 --- a/lib/public_key/doc/src/using_public_key.xml +++ b/lib/public_key/doc/src/using_public_key.xml @@ -22,27 +22,27 @@ Getting Started + + + + using_public_key.xml -
- General information +

This section describes examples of how to use the + public_key API. Keys and certificates used in the following + sections are generated only for testing the public_key + application.

-

This chapter is dedicated to showing some - examples of how to use the public_key API. Keys and certificates - used in the following sections are generated only for the purpose - of testing the public key application.

+

Some shell printouts in the following examples + are abbreviated for increased readability.

-

Note that some shell printouts, in the following examples, - have been abbreviated for increased readability.

- -
- +
- PEM files -

Public key data (keys, certificates etc) may be stored in PEM format. PEM files - comes from the Private Enhanced Mail Internet standard and has a - structure that looks like this:

+ PEM Files +

Public-key data (keys, certificates, and so on) can be stored in + Privacy Enhanced Mail (PEM) format. + The PEM files have the following structure:

<text> -----BEGIN <SOMETHING>----- @@ -51,19 +51,20 @@ -----END <SOMETHING>----- <text> -

A file can contain several BEGIN/END blocks. Text lines between - blocks are ignored. Attributes, if present, are currently ignored except - for Proc-Type and DEK-Info that are used when the DER data is - encrypted.

+

A file can contain several BEGIN/END blocks. Text lines between + blocks are ignored. Attributes, if present, are ignored except + for Proc-Type and DEK-Info, which are used when DER + data is encrypted.

- DSA private key + DSA Private Key +

A DSA private key can look as follows:

+

File handling is not done by the public_key application.

 -

Note file handling is not done by the public_key application.

1> {ok, PemBin} = file:read_file("dsa.pem"). {ok,<<"-----BEGIN DSA PRIVATE KEY-----\nMIIBuw"...>>} -

This PEM file only has one entry, a private DSA key.

+

The following PEM file has only one entry, a private DSA key:

2> [DSAEntry] = public_key:pem_decode(PemBin). [{'DSAPrivateKey',<<48,130,1,187,2,1,0,2,129,129,0,183, 179,230,217,37,99,144,157,21,228,204, @@ -80,21 +81,20 @@
- RSA private key encrypted with a password. + RSA Private Key with Password +

An RSA private key encrypted with a password can look as follows:

1> {ok, PemBin} = file:read_file("rsa.pem"). {ok,<<"Bag Attribut"...>>} -

This PEM file only has one entry a private RSA key.

+

The following PEM file has only one entry, a private RSA key:

2>[RSAEntry] = public_key:pem_decode(PemBin). [{'RSAPrivateKey',<<224,108,117,203,152,40,15,77,128,126, 221,195,154,249,85,208,202,251,109, 119,120,57,29,89,19,9,...>>, - {"DES-EDE3-CBC",<<"kÙeø¼pµL">>}}] - - + {"DES-EDE3-CBC",<<"kÙeø¼pµL">>}}] -

In this example the password is "abcd1234".

+

In this following example, the password is "abcd1234":

3> Key = public_key:pem_entry_decode(RSAEntry, "abcd1234"). #'RSAPrivateKey'{version = 'two-prime', modulus = 1112355156729921663373...2737107, @@ -110,11 +110,12 @@
X509 Certificates +

The following is an example of X509 certificates:

1> {ok, PemBin} = file:read_file("cacerts.pem"). {ok,<<"-----BEGIN CERTIFICATE-----\nMIIC7jCCAl"...>>} -

This file includes two certificates

+

The following file includes two certificates:

2> [CertEntry1, CertEntry2] = public_key:pem_decode(PemBin). [{'Certificate',<<48,130,2,238,48,130,2,87,160,3,2,1,2,2, 9,0,230,145,97,214,191,2,120,150,48,13, @@ -124,7 +125,7 @@ 1,48,13,6,9,42,134,72,134,247,...>>>, not_encrypted}] -

Certificates may of course be decoded as usual ...

+

Certificates can be decoded as usual:

2> Cert = public_key:pem_entry_decode(CertEntry1). #'Certificate'{ tbsCertificate = @@ -212,22 +213,23 @@ signature = {0, <<163,186,7,163,216,152,63,47,154,234,139,73,154,96,120, - 165,2,52,196,195,109,167,192,...>>}} - - -

Parts of certificates can be decoded with - public_key:der_decode/2 using that parts ASN.1 type. - Although application specific certificate - extension requires application specific ASN.1 decode/encode-functions. - Example, the first value of the rdnSequence above is of ASN.1 type - 'X520CommonName'. ({2,5,4,3} = ?id-at-commonName)

+ 165,2,52,196,195,109,167,192,...>>}} + +

Parts of certificates can be decoded with + public_key:der_decode/2, using the ASN.1 type of that part. + However, an application-specific certificate extension requires + application-specific ASN.1 decode/encode-functions. + In the recent example, the first value of rdnSequence is + of ASN.1 type 'X520CommonName'. ({2,5,4,3} = ?id-at-commonName):

public_key:der_decode('X520CommonName', <<19,8,101,114,108,97,110,103,67,65>>). {printableString,"erlangCA"} -

... but certificates can also be decode using the pkix_decode_cert/2 that - can customize and recursively decode standard parts of a certificate.

+

However, certificates can also be decoded using pkix_decode_cert/2, + which can customize and recursively decode standard parts of a certificate:

+ 3>{_, DerCert, _} = CertEntry1. + 4> public_key:pkix_decode_cert(DerCert, otp). #'OTPCertificate'{ tbsCertificate = @@ -316,28 +318,26 @@ signature = {0, <<163,186,7,163,216,152,63,47,154,234,139,73,154,96,120, - 165,2,52,196,195,109,167,192,...>>}} - + 165,2,52,196,195,109,167,192,...>>}} -

This call is equivalent to public_key:pem_entry_decode(CertEntry1)

+

This call is equivalent to public_key:pem_entry_decode(CertEntry1):

5> public_key:pkix_decode_cert(DerCert, plain). -#'Certificate'{ ...} - +#'Certificate'{ ...}
- Encoding public key data to PEM format + Encoding Public-Key Data to PEM Format -

If you have public key data and and want to create a PEM file - you can do that by calling the functions - public_key:pem_entry_encode/2 and pem_encode/1 and then saving the - result to a file. For example assume you have PubKey = - 'RSAPublicKey'{} then you can create a PEM-"RSA PUBLIC KEY" file - (ASN.1 type 'RSAPublicKey') or a PEM-"PUBLIC KEY" file - ('SubjectPublicKeyInfo' ASN.1 type).

+

If you have public-key data and want to create a PEM file + this can be done by calling functions + public_key:pem_entry_encode/2 and pem_encode/1 and + saving the result to a file. For example, assume that you have + PubKey = 'RSAPublicKey'{}. Then you can create a PEM-"RSA PUBLIC KEY" + file (ASN.1 type 'RSAPublicKey') or a PEM-"PUBLIC KEY" file + ('SubjectPublicKeyInfo' ASN.1 type).

-

The second element of the PEM-entry will be the ASN.1 DER encoded - key data.

+

The second element of the PEM-entry is the ASN.1 DER encoded + key data:

1> PemEntry = public_key:pem_entry_encode('RSAPublicKey', RSAPubKey). {'RSAPublicKey', <<48,72,...>>, not_encrypted} @@ -348,7 +348,7 @@ 3> file:write_file("rsa_pub_key.pem", PemBin). ok -

or

+

or:

1> PemEntry = public_key:pem_entry_encode('SubjectPublicKeyInfo', RSAPubKey). {'SubjectPublicKeyInfo', <<48,92...>>, not_encrypted} @@ -363,96 +363,106 @@ ok
- RSA public key cryptography -

Suppose you have PrivateKey = #'RSAPrivateKey{}' and the - plaintext Msg = binary() and the corresponding public key - PublicKey = #'RSAPublicKey'{} then you can do the following. - Note that you normally will only do one of the encrypt or - decrypt operations and the peer will do the other. -

- -

Encrypt with the private key

+ RSA Public-Key Cryptography +

Suppose you have the followwing private key and a corresponding public key:

+ + PrivateKey = #'RSAPrivateKey{}' and + the plaintext Msg = binary() + PublicKey = #'RSAPublicKey'{} + + +

Then you can proceed as follows:

+ +

Encrypt with the private key:

RsaEncrypted = public_key:encrypt_private(Msg, PrivateKey), Msg = public_key:decrypt_public(RsaEncrypted, PublicKey), -

Encrypt with the public key

+

Encrypt with the public key:

RsaEncrypted = public_key:encrypt_public(Msg, PublicKey), Msg = public_key:decrypt_private(RsaEncrypted, PrivateKey), + +

You normally do only one of the encrypt or decrypt operations, + and the peer does the other.

 +
- Digital signatures + Digital Signatures -

Suppose you have PrivateKey = #'RSAPrivateKey{}'or - #'DSAPrivateKey'{} and the plaintext Msg = binary() and the - corresponding public key PublicKey = #'RSAPublicKey'{} or - {integer(), #'DssParams'{}} then you can do the following. Note - that you normally will only do one of the sign or verify operations - and the peer will do the other.

+

Suppose you have the following private key and a corresponding public key:

+ + + PrivateKey = #'RSAPrivateKey{}' or + #'DSAPrivateKey'{} and the plaintext Msg = binary() + PublicKey = #'RSAPublicKey'{} or + {integer(), #'DssParams'{}} + +

Then you can proceed as follows:

Signature = public_key:sign(Msg, sha, PrivateKey), true = public_key:verify(Msg, sha, Signature, PublicKey), -

It might be appropriate to calculate the message digest before - calling sign or verify and then you can use the none as second - argument.

+

You normally do only one of the sign or verify operations, + and the peer does the other.

 + +

It can be appropriate to calculate the message digest before + calling sign or verify, and then use none as + second argument:

Digest = crypto:sha(Msg), Signature = public_key:sign(Digest, none, PrivateKey), -true = public_key:verify(Digest, none, Signature, PublicKey), - +true = public_key:verify(Digest, none, Signature, PublicKey),
- SSH files + SSH Files

SSH typically uses PEM files for private keys but has its - own file format for storing public keys. The erlang public_key - application can be used to parse the content of SSH public key files.

+ own file format for storing public keys. The public_key + application can be used to parse the content of SSH public-key files.

- RFC 4716 SSH public key files + RFC 4716 SSH Public-Key Files

RFC 4716 SSH files looks confusingly like PEM files, - but there are some differences.

+ but there are some differences:

1> {ok, SshBin} = file:read_file("ssh2_rsa_pub"). {ok, <<"---- BEGIN SSH2 PUBLIC KEY ----\nAAAA"...>>} -

This is equivalent to calling public_key:ssh_decode(SshBin, rfc4716_public_key). +

This is equivalent to calling public_key:ssh_decode(SshBin, rfc4716_public_key):

2> public_key:ssh_decode(SshBin, public_key). [{#'RSAPublicKey'{modulus = 794430685...91663, - publicExponent = 35}, []}] - + publicExponent = 35}, []}]
- Openssh public key format + OpenSSH Public-Key Format +

OpenSSH public-key format looks as follows:

1> {ok, SshBin} = file:read_file("openssh_dsa_pub"). {ok,<<"ssh-dss AAAAB3Nza"...>>} -

This is equivalent to calling public_key:ssh_decode(SshBin, openssh_public_key). +

This is equivalent to calling public_key:ssh_decode(SshBin, openssh_public_key):

2> public_key:ssh_decode(SshBin, public_key). [{{15642692...694280725, #'Dss-Parms'{p = 17291273936...696123221, q = 1255626590179665817295475654204371833735706001853, g = 10454211196...480338645}}, - [{comment,"dhopson@VMUbuntu-DSH"}]}] - + [{comment,"dhopson@VMUbuntu-DSH"}]}]
- Known hosts - openssh format - + Known Hosts - OpenSSH Format +

Known hosts - OpenSSH format looks as follows:

1> {ok, SshBin} = file:read_file("known_hosts"). {ok,<<"hostname.domain.com,192.168.0.1 ssh-rsa AAAAB...>>} -

Returns a list of public keys and their related attributes - each pair of key and attributes corresponds to one entry in - the known hosts file.

+

Returns a list of public keys and their related attributes. + Each pair of key and attribute corresponds to one entry in + the known hosts file:

2> public_key:ssh_decode(SshBin, known_hosts). [{#'RSAPublicKey'{modulus = 1498979460408...72721699, @@ -461,19 +471,19 @@ true = public_key:verify(Digest, none, Signature, PublicKey), {#'RSAPublicKey'{modulus = 14989794604088...2721699, publicExponent = 35}, [{comment,"foo@bar.com"}, - {hostnames,["|1|BWO5qDxk/cFH0wa05JLdHn+j6xQ=|rXQvIxh5cDD3C43k5DPDamawVNA="]}]}] - + {hostnames,["|1|BWO5qDxk/cFH0wa05JLdHn+j6xQ=|rXQvIxh5cDD3C43k5DPDamawVNA="]}]}]
- Authorized keys - openssh format + Authorized Keys - OpenSSH Format +

Authorized keys - OpenSSH format looks as follows:

1> {ok, SshBin} = file:read_file("auth_keys"). {ok, <<"command=\"dump /home\",no-pty,no-port-forwarding ssh-rsa AAA...>>} -

Returns a list of public keys and their related attributes - each pair of key and attributes corresponds to one entry in - the authorized key file.

+

Returns a list of public keys and their related attributes. + Each pair of key and attribute corresponds to one entry in + the authorized key file:

2> public_key:ssh_decode(SshBin, auth_keys). [{#'RSAPublicKey'{modulus = 794430685...691663, @@ -485,16 +495,15 @@ true = public_key:verify(Digest, none, Signature, PublicKey), #'Dss-Parms'{p = 17291273936185...763696123221, q = 1255626590179665817295475654204371833735706001853, g = 10454211195705...60511039590076780999046480338645}}, - [{comment,"dhopson@VMUbuntu-DSH"}]}] - + [{comment,"dhopson@VMUbuntu-DSH"}]}]
- Creating an SSH file from public key data + Creating an SSH File from Public-Key Data

If you got a public key PubKey and a related list of attributes Attributes as returned - by ssh_decode/2 you can create a new ssh file for example

+ by ssh_decode/2, you can create a new SSH file, for example:

N> SshBin = public_key:ssh_encode([{PubKey, Attributes}], openssh_public_key), <<"ssh-rsa "...>> N+1> file:write_file("id_rsa.pub", SshBin). -- cgit v1.2.3 From f1484e1bd971d75bb232bc4f50d25473e1046e65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Thu, 7 May 2015 15:45:43 +0200 Subject: code: Make load_native_code_for_all_loaded/0 comply to spec 7309ff4c38325 introduced a mismatch between load_native_code_for_all_loaded/0 and its spec. We could just delete spec, but it is cleaner to ensure that the function always returns 'ok'. Noticed-by: Tuncer Ayaz --- lib/kernel/src/code.erl | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/kernel/src/code.erl b/lib/kernel/src/code.erl index a8cbdf9667..d73d1ff281 100644 --- a/lib/kernel/src/code.erl +++ b/lib/kernel/src/code.erl @@ -564,7 +564,8 @@ load_native_code_for_all_loaded() -> catch _:_ -> ok - end. + end, + ok. load_all_native(Loaded, ChunkTag) -> catch load_all_native_1(Loaded, ChunkTag). -- cgit v1.2.3 From 25575183ca581a080478ad499e308a76e44e4def Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Fri, 24 Apr 2015 17:42:54 +0200 Subject: public_key: Change structure to what editor intended --- lib/public_key/doc/src/Makefile | 3 +- lib/public_key/doc/src/cert_records.xml | 743 ----------------------- lib/public_key/doc/src/public_key.xml | 3 +- lib/public_key/doc/src/public_key_records.xml | 155 ----- lib/public_key/doc/src/records.xml | 821 +++++++++++++++++++++++++- 5 files changed, 804 insertions(+), 921 deletions(-) delete mode 100644 lib/public_key/doc/src/cert_records.xml delete mode 100644 lib/public_key/doc/src/public_key_records.xml (limited to 'lib') diff --git a/lib/public_key/doc/src/Makefile b/lib/public_key/doc/src/Makefile index 17fb67e95c..2adc13a5cf 100644 --- a/lib/public_key/doc/src/Makefile +++ b/lib/public_key/doc/src/Makefile @@ -42,8 +42,7 @@ XML_REF6_FILES = XML_PART_FILES = part.xml part_notes.xml XML_CHAPTER_FILES = \ introduction.xml \ - public_key_records.xml \ - cert_records.xml \ + records.xml \ using_public_key.xml \ notes.xml diff --git a/lib/public_key/doc/src/cert_records.xml b/lib/public_key/doc/src/cert_records.xml deleted file mode 100644 index 4d4533fe21..0000000000 --- a/lib/public_key/doc/src/cert_records.xml +++ /dev/null @@ -1,743 +0,0 @@ - - - - -
- - 2008 - 2014 - Ericsson AB, All Rights Reserved - - - The contents of this file are subject to the Erlang Public License, - Version 1.1, (the "License"); you may not use this file except in - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - The Initial Developer of the Original Code is Ericsson AB. - - - Certificate Records - Ingela Anderton Andin - - - - - 2008-02-06 - A - cert_records.xml -
- -

This section briefly describes Erlang records derived from ASN.1 - specifications used to handle X509 certificates and CertificationRequest. - The scope is to describe the data types of each component, - not the semantics. For information on the semantics, refer to RFC 5280 and - PKCS-10. -

- -

Use the following include directive to get access to the - records and constant macros (OIDs) described in the following sections:

- - -include_lib("public_key/include/public_key.hrl"). - -

The used ASN.1 specifications are available in the asn1 subdirectory - of the public_key application.

- -
- Common Data Types - -

Common non-standard Erlang - data types used to describe the record fields in the - following sections are defined in the public_key Reference Manual, or - follows here:

- - - time() -

= uct_time() | general_time()

 - - uct_time() -

= {utcTime, "YYMMDDHHMMSSZ"}

 - - general_time() -

= {generalTime, "YYYYMMDDHHMMSSZ"}

 - - general_name() - =

{rfc822Name, string()}

-

| {dNSName, string()}

-

| {x400Address, string()}

-

| {directoryName, {rdnSequence, [#AttributeTypeAndValue'{}]}}

-

| {eidPartyName, special_string()}

-

| {eidPartyName, special_string(), special_string()}

-

| {uniformResourceIdentifier, string()}

-

| {ipAddress, string()}

-

| {registeredId, oid()}

-

| {otherName, term()}

- - - special_string() - =

{teletexString, string()}

-

| {printableString, string()}

-

| {universalString, string()}

-

| {utf8String, binary()}

-

| {bmpString, string()}

- - - dist_reason() - =

unused

-

| keyCompromise

-

| cACompromise

-

| affiliationChanged

-

| superseded

-

| cessationOfOperation

-

| certificateHold

-

| privilegeWithdrawn

-

| aACompromise

- - - -
- -
- PKIX Certificates -

Erlang representation of PKIX certificates derived from ASN.1 - specifications and RFC 5280 are as follows:

- -#'Certificate'{ - tbsCertificate, % #'TBSCertificate'{} - signatureAlgorithm, % #'AlgorithmIdentifier'{} - signature % bitstring() - }. - -#'TBSCertificate'{ - version, % v1 | v2 | v3 - serialNumber, % integer() - signature, % #'AlgorithmIdentifier'{} - issuer, % {rdnSequence, [#AttributeTypeAndValue'{}]} - validity, % #'Validity'{} - subject, % {rdnSequence, [#AttributeTypeAndValue'{}]} - subjectPublicKeyInfo, % #'SubjectPublicKeyInfo'{} - issuerUniqueID, % binary() | asn1_novalue - subjectUniqueID, % binary() | asn1_novalue - extensions % [#'Extension'{}] - }. - -#'AlgorithmIdentifier'{ - algorithm, % oid() - parameters % der_encoded() - }. - - -#'OTPCertificate'{ - tbsCertificate, % #'OTPTBSCertificate'{} - signatureAlgorithm, % #'SignatureAlgorithm' - signature % bitstring() - }. - -#'OTPTBSCertificate'{ - version, % v1 | v2 | v3 - serialNumber, % integer() - signature, % #'SignatureAlgorithm' - issuer, % {rdnSequence, [#AttributeTypeAndValue'{}]} - validity, % #'Validity'{} - subject, % {rdnSequence, [#AttributeTypeAndValue'{}]} - subjectPublicKeyInfo, % #'OTPSubjectPublicKeyInfo'{} - issuerUniqueID, % binary() | asn1_novalue - subjectUniqueID, % binary() | asn1_novalue - extensions % [#'Extension'{}] - }. - -#'SignatureAlgorithm'{ - algorithm, % id_signature_algorithm() - parameters % asn1_novalue | #'Dss-Parms'{} - }. - -

Here, id_signature_algorithm() = ?OID name, for available OID names, for example -?id-dsa-with-sha1. That is, by prepending "?" to the OID name, represented as an Erlang atom.

-

The available OID names are as follows:

- - - OID Name - - - id-dsa-with-sha1 - - - id-dsaWithSHA1 (ISO or OID to above) - - - md2WithRSAEncryption - - - md5WithRSAEncryption - - - sha1WithRSAEncryption - - - sha-1WithRSAEncryption (ISO or OID to above) - - - sha224WithRSAEncryption - - - sha256WithRSAEncryption - - - sha512WithRSAEncryption - - - ecdsa-with-SHA1 - - Signature Algorithm OIDs -
- -

The data type 'AttributeTypeAndValue', is represented as - the following erlang record:

- - -#'AttributeTypeAndValue'{ - type, % id_attributes() - value % term() - }. - -

The attribute OID name atoms and their corresponding value types -are as follows:

- - - OID Name - Value Type - - - id-at-name - special_string() - - - id-at-surname - special_string() - - - id-at-givenName - special_string() - - - id-at-initials - special_string() - - - id-at-generationQualifier - special_string() - - - id-at-commonName - special_string() - - - id-at-localityName - special_string() - - - id-at-stateOrProvinceName - special_string() - - - id-at-organizationName - special_string() - - - id-at-title - special_string() - - - id-at-dnQualifier - {printableString, string()} - - - id-at-countryName - {printableString, string()} - - - id-at-serialNumber - {printableString, string()} - - - id-at-pseudonym - special_string() - - Attribute OIDs -
- -

The data types 'Validity', 'SubjectPublicKeyInfo', and -'SubjectPublicKeyInfoAlgorithm' are represented as the following Erlang records:

- - -#'Validity'{ - notBefore, % time() - notAfter % time() - }. - -#'SubjectPublicKeyInfo'{ - algorithm, % #AlgorithmIdentifier{} - subjectPublicKey % binary() - }. - -#'SubjectPublicKeyInfoAlgorithm'{ - algorithm, % id_public_key_algorithm() - parameters % public_key_params() - }. - -

The public-key algorithm OID name atoms are as follows:

- - - OID Name - - - rsaEncryption - - - id-dsa - - - dhpublicnumber - - - id-keyExchangeAlgorithm - - - id-ecPublicKey - - Public-Key Algorithm OIDs -
- - -#'Extension'{ - extnID, % id_extensions() | oid() - critical, % boolean() - extnValue % der_encoded() - }. - -

id_extensions() - Standard Certificate Extensions, - Private Internet Extensions, - CRL Extensions and - CRL Entry Extensions. -

- -
- -
- - Standard Certificate Extensions - -

The standard certificate extensions OID name atoms and their - corresponding value types are as follows:

- - - - OID Name - Value Type - - - id-ce-authorityKeyIdentifier - #'AuthorityKeyIdentifier'{} - - - id-ce-subjectKeyIdentifier - oid() - - - id-ce-keyUsage - [key_usage()] - - - id-ce-privateKeyUsagePeriod - #'PrivateKeyUsagePeriod'{} - - - id-ce-certificatePolicies - #'PolicyInformation'{} - - - - id-ce-policyMappings - #'PolicyMappings_SEQOF'{} - - - - id-ce-subjectAltName - general_name() - - - - id-ce-issuerAltName - general_name() - - - - id-ce-subjectDirectoryAttributes - [#'Attribute'{}] - - - - id-ce-basicConstraints - #'BasicConstraints'{} - - - id-ce-nameConstraints - #'NameConstraints'{} - - - id-ce-policyConstraints - #'PolicyConstraints'{} - - - id-ce-extKeyUsage - [id_key_purpose()] - - - - id-ce-cRLDistributionPoints - [#'DistributionPoint'{}] - - - - id-ce-inhibitAnyPolicy - integer() - - - - id-ce-freshestCRL - [#'DistributionPoint'{}] - - - - Standard Certificate Extensions -
- -

Here:

- - key_usage() - =

digitalSignature

-

| nonRepudiation

-

| keyEncipherment

-

| dataEncipherment

-

| keyAgreement

-

| keyCertSign

-

| cRLSign

-

| encipherOnly

-

| decipherOnly

- - - -

And for id_key_purpose():

- - - - OID Name - - - id-kp-serverAuth - - - id-kp-clientAuth - - - id-kp-codeSigning - - - id-kp-emailProtection - - - id-kp-timeStamping - - - id-kp-OCSPSigning - - Key Purpose OIDs -
- - -#'AuthorityKeyIdentifier'{ - keyIdentifier, % oid() - authorityCertIssuer, % general_name() - authorityCertSerialNumber % integer() - }. - -#'PrivateKeyUsagePeriod'{ - notBefore, % general_time() - notAfter % general_time() - }. - -#'PolicyInformation'{ - policyIdentifier, % oid() - policyQualifiers % [#PolicyQualifierInfo{}] - }. - -#'PolicyQualifierInfo'{ - policyQualifierId, % oid() - qualifier % string() | #'UserNotice'{} - }. - -#'UserNotice'{ - noticeRef, % #'NoticeReference'{} - explicitText % string() - }. - -#'NoticeReference'{ - organization, % string() - noticeNumbers % [integer()] - }. - -#'PolicyMappings_SEQOF'{ - issuerDomainPolicy, % oid() - subjectDomainPolicy % oid() - }. - -#'Attribute'{ - type, % oid() - values % [der_encoded()] - }). - -#'BasicConstraints'{ - cA, % boolean() - pathLenConstraint % integer() - }). - -#'NameConstraints'{ - permittedSubtrees, % [#'GeneralSubtree'{}] - excludedSubtrees % [#'GeneralSubtree'{}] - }). - -#'GeneralSubtree'{ - base, % general_name() - minimum, % integer() - maximum % integer() - }). - -#'PolicyConstraints'{ - requireExplicitPolicy, % integer() - inhibitPolicyMapping % integer() - }). - -#'DistributionPoint'{ - distributionPoint, % {fullName, [general_name()]} | {nameRelativeToCRLIssuer, - [#AttributeTypeAndValue{}]} - reasons, % [dist_reason()] - cRLIssuer % [general_name()] - }). - -
- -
- - Private Internet Extensions - -

The private internet extensions OID name atoms and their corresponding value - types are as follows:

- - - - OID Name - Value Type - - - id-pe-authorityInfoAccess - [#'AccessDescription'{}] - - - id-pe-subjectInfoAccess - [#'AccessDescription'{}] - - Private Internet Extensions -
- - -#'AccessDescription'{ - accessMethod, % oid() - accessLocation % general_name() - }). - -
- -
- CRL and CRL Extensions Profile - -

Erlang representation of CRL and CRL extensions profile - derived from ASN.1 specifications and RFC 5280 are as follows:

- - -#'CertificateList'{ - tbsCertList, % #'TBSCertList{} - signatureAlgorithm, % #'AlgorithmIdentifier'{} - signature % bitstring() - }). - -#'TBSCertList'{ - version, % v2 (if defined) - signature, % #AlgorithmIdentifier{} - issuer, % {rdnSequence, [#AttributeTypeAndValue'{}]} - thisUpdate, % time() - nextUpdate, % time() - revokedCertificates, % [#'TBSCertList_revokedCertificates_SEQOF'{}] - crlExtensions % [#'Extension'{}] - }). - -#'TBSCertList_revokedCertificates_SEQOF'{ - userCertificate, % integer() - revocationDate, % timer() - crlEntryExtensions % [#'Extension'{}] - }). - -
- - CRL Extensions - -

The CRL extensions OID name atoms and their corresponding value types are as follows:

- - - - - OID Name - Value Type - - - id-ce-authorityKeyIdentifier - #'AuthorityKeyIdentifier{} - - - id-ce-issuerAltName - {rdnSequence, [#AttributeTypeAndValue'{}]} - - - id-ce-cRLNumber - integer() - - - id-ce-deltaCRLIndicator - integer() - - - id-ce-issuingDistributionPoint - #'IssuingDistributionPoint'{} - - - id-ce-freshestCRL - [#'Distributionpoint'{}] - - - CRL Extensions -
- -

Here, the data type 'IssuingDistributionPoint' is represented as - the following Erlang record:

- - -#'IssuingDistributionPoint'{ - distributionPoint, % {fullName, [general_name()]} | {nameRelativeToCRLIssuer, - [#AttributeTypeAndValue'{}]} - onlyContainsUserCerts, % boolean() - onlyContainsCACerts, % boolean() - onlySomeReasons, % [dist_reason()] - indirectCRL, % boolean() - onlyContainsAttributeCerts % boolean() - }). -
- -
- - CRL Entry Extensions - -

The CRL entry extensions OID name atoms and their corresponding value types are as follows:

- - - - OID Name - Value Type - - - id-ce-cRLReason - crl_reason() - - - id-ce-holdInstructionCode - oid() - - - id-ce-invalidityDate - general_time() - - - id-ce-certificateIssuer - general_name() - - CRL Entry Extensions -
- - -

Here:

- - crl_reason() - =

unspecifiedc>

-

| keyCompromise

-

| cACompromise

-

| affiliationChanged

-

| superseded

-

| cessationOfOperation

-

| certificateHold

-

| removeFromCRL

-

| privilegeWithdrawn

-

| aACompromise

- - - -
- -
- - PKCS#10 Certification Request -

Erlang representation of a PKCS#10 certification request - derived from ASN.1 specifications and RFC 5280 are as follows:

- -#'CertificationRequest'{ - certificationRequestInfo #'CertificationRequestInfo'{}, - signatureAlgorithm #'CertificationRequest_signatureAlgorithm'{}}. - signature bitstring() - } - -#'CertificationRequestInfo'{ - version atom(), - subject {rdnSequence, [#AttributeTypeAndValue'{}]} , - subjectPKInfo #'CertificationRequestInfo_subjectPKInfo'{}, - attributes [#'AttributePKCS-10' {}] - } - -#'CertificationRequestInfo_subjectPKInfo'{ - algorithm #'CertificationRequestInfo_subjectPKInfo_algorithm'{} - subjectPublicKey bitstring() - } - -#'CertificationRequestInfo_subjectPKInfo_algorithm'{ - algorithm = oid(), - parameters = der_encoded() -} - -#'CertificationRequest_signatureAlgorithm'{ - algorithm = oid(), - parameters = der_encoded() - } - -#'AttributePKCS-10'{ - type = oid(), - values = [der_encoded()] -} -
- -
- diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index ddaa8c2530..3d5c135075 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -73,8 +73,7 @@ are generated from ASN.1 specifications and are documented in the User's Guide. See Public-key Records and X.509 Certificate Records. + marker="public_key_records">Public-key Records.

Use the following include directive to get access to the diff --git a/lib/public_key/doc/src/public_key_records.xml b/lib/public_key/doc/src/public_key_records.xml deleted file mode 100644 index 24f5faf38e..0000000000 --- a/lib/public_key/doc/src/public_key_records.xml +++ /dev/null @@ -1,155 +0,0 @@ - - - - -

- - 2008 - 2014 - Ericsson AB, All Rights Reserved - - - The contents of this file are subject to the Erlang Public License, - Version 1.1, (the "License"); you may not use this file except in - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - The Initial Developer of the Original Code is Ericsson AB. - - - Public-Key Records - Ingela Anderton Andin - - - - - 2008-02-06 - A - public_key_records.xml -
- -

This section briefly describes Erlang records derived from ASN.1 - specifications used to handle public and private keys. - The scope is to describe the data types of each component, - not the semantics. For information on the - semantics, refer to the relevant standards and RFCs.

- -

Use the following include directive to get access to the - records and constant macros described in the following sections:

- - -include_lib("public_key/include/public_key.hrl"). - -
- Common Data Types - -

Common non-standard Erlang - data types used to describe the record fields in the - following sections are defined in the public_key Reference Manual.

-
- -
- The RSA According to PKCS-1 and RFC 3447 -

RSA as defined by the PKCS-1 standard and - RFC 3447 follows:

- - -#'RSAPublicKey'{ - modulus, % integer() - publicExponent % integer() - }. - -#'RSAPrivateKey'{ - version, % two-prime | multi - modulus, % integer() - publicExponent, % integer() - privateExponent, % integer() - prime1, % integer() - prime2, % integer() - exponent1, % integer() - exponent2, % integer() - coefficient, % integer() - otherPrimeInfos % [#OtherPrimeInfo{}] | asn1_NOVALUE - }. - -#'OtherPrimeInfo'{ - prime, % integer() - exponent, % integer() - coefficient % integer() - }. - -
- -
- DSA According to DSS -

The DSA as defined by the - - Digital Signature Standard (DSS), NIST FIPS PUB 186-2 follows:

- - -#'DSAPrivateKey',{ - version, % integer() - p, % integer() - q, % integer() - g, % integer() - y, % integer() - x % integer() - }. - -#'Dss-Parms',{ - p, % integer() - q, % integer() - g % integer() - }. -
- -
- ECC According to RFC 5480 -

The Elliptic Curve (ECC) as defined by - RFC 5480 follows:

- - -#'ECPrivateKey'{ - version, % integer() - privateKey, % binary() - parameters, % der_encoded() - {'EcpkParameters', #'ECParameters'{}} | - {'EcpkParameters', {namedCurve, oid()}} | - {'EcpkParameters', 'NULL'} % Inherited by CA - publicKey % bitstring() - }. - -#'ECParameters'{ - version, % integer() - fieldID, % #'FieldID'{} - curve, % #'Curve'{} - base, % binary() - order, % integer() - cofactor % integer() - }. - -#'Curve'{ - a, % binary() - b, % binary() - seed % bitstring() - optional - - }. - -#'FieldID'{ - fieldType, % oid() - parameters % Depending on fieldType - }. - -#'ECPoint'{ - point % binary() - the public key - }. - - -
- - diff --git a/lib/public_key/doc/src/records.xml b/lib/public_key/doc/src/records.xml index 75265791af..ac1ecd176c 100644 --- a/lib/public_key/doc/src/records.xml +++ b/lib/public_key/doc/src/records.xml @@ -1,7 +1,7 @@ - + - +
2008 @@ -23,25 +23,808 @@ The Initial Developer of the Original Code is Ericsson AB. - Records - Tommy MÃ¥nevik + Public-Key Records + Ingela Anderton Andin + - 2015-04-01 - - records.xml + + + 2008-02-06 + A + public_key_records.xml
- -

This section describes Erlang records derived from ASN.1 specifications, - used to handle the following: -

- - Public and private keys - X509 certificates and CertificationRequest - - + +

This chapter briefly describes Erlang records derived from ASN.1 + specifications used to handle public key infrastructure. + The scope is to describe the data types of each component, + not the semantics. For information on the + semantics, refer to the relevant standards and RFCs linked in the sections below.

+ +

Use the following include directive to get access to the + records and constant macros described in the following sections:

+ + -include_lib("public_key/include/public_key.hrl"). + +
+ Data Types + +

Common non-standard Erlang + data types used to describe the record fields in the + following sections and which are not defined in the public_key Reference Manual + follows here:

+ + + time() +

= uct_time() | general_time()

 + + uct_time() +

= {utcTime, "YYMMDDHHMMSSZ"}

 + + general_time() +

= {generalTime, "YYYYMMDDHHMMSSZ"}

 + + general_name() + =

{rfc822Name, string()}

+

| {dNSName, string()}

+

| {x400Address, string()}

+

| {directoryName, {rdnSequence, [#AttributeTypeAndValue'{}]}}

+

| {eidPartyName, special_string()}

+

| {eidPartyName, special_string(), special_string()}

+

| {uniformResourceIdentifier, string()}

+

| {ipAddress, string()}

+

| {registeredId, oid()}

+

| {otherName, term()}

+ + + special_string() + =

{teletexString, string()}

+

| {printableString, string()}

+

| {universalString, string()}

+

| {utf8String, binary()}

+

| {bmpString, string()}

+ + + dist_reason() + =

unused

+

| keyCompromise

+

| cACompromise

+

| affiliationChanged

+

| superseded

+

| cessationOfOperation

+

| certificateHold

+

| privilegeWithdrawn

+

| aACompromise

+ + + +
+ +
+ RSA +

Erlang representation of + Rivest-Shamir-Adleman cryptosystem (RSA) keys follows:

+ + +#'RSAPublicKey'{ + modulus, % integer() + publicExponent % integer() + }. + +#'RSAPrivateKey'{ + version, % two-prime | multi + modulus, % integer() + publicExponent, % integer() + privateExponent, % integer() + prime1, % integer() + prime2, % integer() + exponent1, % integer() + exponent2, % integer() + coefficient, % integer() + otherPrimeInfos % [#OtherPrimeInfo{}] | asn1_NOVALUE + }. + +#'OtherPrimeInfo'{ + prime, % integer() + exponent, % integer() + coefficient % integer() + }. + +
+ +
+ DSA +

Erlang representation of Digigital Signature Algorithm (DSA) keys

+ +#'DSAPrivateKey',{ + version, % integer() + p, % integer() + q, % integer() + g, % integer() + y, % integer() + x % integer() + }. + +#'Dss-Parms',{ + p, % integer() + q, % integer() + g % integer() + }. + +
+ +
+ ECDSA +

Erlang representation of Elliptic Curve Digital Signature Algorithm (ECDSA) keys follows:

+ + +#'ECPrivateKey'{ + version, % integer() + privateKey, % octet_string() + parameters, % der_encoded() - {'EcpkParameters', #'ECParameters'{}} | + {'EcpkParameters', {namedCurve, oid()}} | + {'EcpkParameters', 'NULL'} % Inherited by CA + publicKey % bitstring() + }. + +#'ECParameters'{ + version, % integer() + fieldID, % #'FieldID'{} + curve, % #'Curve'{} + base, % octet_string() + order, % integer() + cofactor % integer() + }. + +#'Curve'{ + a, % octet_string() + b, % octet_string() + seed % bitstring() - optional + + }. + +#'FieldID'{ + fieldType, % oid() + parameters % Depending on fieldType + }. + +#'ECPoint'{ + point % octet_string() - the public key + }. +
+ +
+ PKIX Certificates +

Erlang representation of PKIX certificates derived from ASN.1 + specifications see also X509 certificates (RFC 5280) are as follows:

+ +#'Certificate'{ + tbsCertificate, % #'TBSCertificate'{} + signatureAlgorithm, % #'AlgorithmIdentifier'{} + signature % {0, binary()} - ASN1 compact bitstring + }. + +#'TBSCertificate'{ + version, % v1 | v2 | v3 + serialNumber, % integer() + signature, % #'AlgorithmIdentifier'{} + issuer, % {rdnSequence, [#AttributeTypeAndValue'{}]} + validity, % #'Validity'{} + subject, % {rdnSequence, [#AttributeTypeAndValue'{}]} + subjectPublicKeyInfo, % #'SubjectPublicKeyInfo'{} + issuerUniqueID, % binary() | asn1_novalue + subjectUniqueID, % binary() | asn1_novalue + extensions % [#'Extension'{}] + }. + +#'AlgorithmIdentifier'{ + algorithm, % oid() + parameters % der_encoded() + }. + + +#'OTPCertificate'{ + tbsCertificate, % #'OTPTBSCertificate'{} + signatureAlgorithm, % #'SignatureAlgorithm' + signature % {0, binary()} - ASN1 compact bitstring + }. + +#'OTPTBSCertificate'{ + version, % v1 | v2 | v3 + serialNumber, % integer() + signature, % #'SignatureAlgorithm' + issuer, % {rdnSequence, [#AttributeTypeAndValue'{}]} + validity, % #'Validity'{} + subject, % {rdnSequence, [#AttributeTypeAndValue'{}]} + subjectPublicKeyInfo, % #'OTPSubjectPublicKeyInfo'{} + issuerUniqueID, % binary() | asn1_novalue + subjectUniqueID, % binary() | asn1_novalue + extensions % [#'Extension'{}] + }. + +#'SignatureAlgorithm'{ + algorithm, % id_signature_algorithm() + parameters % asn1_novalue | #'Dss-Parms'{} + }. + +

Here, id_signature_algorithm() = ?OID name, for available OID names, for example +?id-dsa-with-sha1. That is, by prepending "?" to the OID name, represented as an Erlang atom.

+

The available OID names are as follows:

+ + + OID Name + + + id-dsa-with-sha1 + + + id-dsaWithSHA1 (ISO or OID to above) + + + md2WithRSAEncryption + + + md5WithRSAEncryption + + + sha1WithRSAEncryption + + + sha-1WithRSAEncryption (ISO or OID to above) + + + sha224WithRSAEncryption + + + sha256WithRSAEncryption + + + sha512WithRSAEncryption + + + ecdsa-with-SHA1 + + Signature Algorithm OIDs +
+ +

The data type 'AttributeTypeAndValue', is represented as + the following erlang record:

+ + +#'AttributeTypeAndValue'{ + type, % id_attributes() + value % term() + }. + +

The attribute OID name atoms and their corresponding value types +are as follows:

+ + + OID Name + Value Type + + + id-at-name + special_string() + + + id-at-surname + special_string() + + + id-at-givenName + special_string() + + + id-at-initials + special_string() + + + id-at-generationQualifier + special_string() + + + id-at-commonName + special_string() + + + id-at-localityName + special_string() + + + id-at-stateOrProvinceName + special_string() + + + id-at-organizationName + special_string() + + + id-at-title + special_string() + + + id-at-dnQualifier + {printableString, string()} + + + id-at-countryName + {printableString, string()} + + + id-at-serialNumber + {printableString, string()} + + + id-at-pseudonym + special_string() + + Attribute OIDs +
+ +

The data types 'Validity', 'SubjectPublicKeyInfo', and +'SubjectPublicKeyInfoAlgorithm' are represented as the following Erlang records:

+ + +#'Validity'{ + notBefore, % time() + notAfter % time() + }. + +#'SubjectPublicKeyInfo'{ + algorithm, % #AlgorithmIdentifier{} + subjectPublicKey % binary() + }. + +#'SubjectPublicKeyInfoAlgorithm'{ + algorithm, % id_public_key_algorithm() + parameters % public_key_params() + }. + +

The public-key algorithm OID name atoms are as follows:

+ + + OID Name + + + rsaEncryption + + + id-dsa + + + dhpublicnumber + + + id-keyExchangeAlgorithm + + + id-ecPublicKey + + Public-Key Algorithm OIDs +
+ + +#'Extension'{ + extnID, % id_extensions() | oid() + critical, % boolean() + extnValue % der_encoded() + }. + +

id_extensions() + Standard Certificate Extensions, + Private Internet Extensions, + CRL Extensions and + CRL Entry Extensions. +

+ +
+ +
+ + Standard Certificate Extensions + +

The standard certificate extensions OID name atoms and their + corresponding value types are as follows:

+ + + + OID Name + Value Type + + + id-ce-authorityKeyIdentifier + #'AuthorityKeyIdentifier'{} + + + id-ce-subjectKeyIdentifier + oid() + + + id-ce-keyUsage + [key_usage()] + + + id-ce-privateKeyUsagePeriod + #'PrivateKeyUsagePeriod'{} + + + id-ce-certificatePolicies + #'PolicyInformation'{} + + + + id-ce-policyMappings + #'PolicyMappings_SEQOF'{} + + + + id-ce-subjectAltName + general_name() + + + + id-ce-issuerAltName + general_name() + + + + id-ce-subjectDirectoryAttributes + [#'Attribute'{}] + + + + id-ce-basicConstraints + #'BasicConstraints'{} + + + id-ce-nameConstraints + #'NameConstraints'{} + + + id-ce-policyConstraints + #'PolicyConstraints'{} + + + id-ce-extKeyUsage + [id_key_purpose()] + + + + id-ce-cRLDistributionPoints + [#'DistributionPoint'{}] + + + + id-ce-inhibitAnyPolicy + integer() + + + + id-ce-freshestCRL + [#'DistributionPoint'{}] + + + + Standard Certificate Extensions +
+ +

Here:

+ + key_usage() + =

digitalSignature

+

| nonRepudiation

+

| keyEncipherment

+

| dataEncipherment

+

| keyAgreement

+

| keyCertSign

+

| cRLSign

+

| encipherOnly

+

| decipherOnly

+ + + +

And for id_key_purpose():

+ + + + OID Name + + + id-kp-serverAuth + + + id-kp-clientAuth + + + id-kp-codeSigning + + + id-kp-emailProtection + + + id-kp-timeStamping + + + id-kp-OCSPSigning + + Key Purpose OIDs +
+ + +#'AuthorityKeyIdentifier'{ + keyIdentifier, % oid() + authorityCertIssuer, % general_name() + authorityCertSerialNumber % integer() + }. + +#'PrivateKeyUsagePeriod'{ + notBefore, % general_time() + notAfter % general_time() + }. + +#'PolicyInformation'{ + policyIdentifier, % oid() + policyQualifiers % [#PolicyQualifierInfo{}] + }. + +#'PolicyQualifierInfo'{ + policyQualifierId, % oid() + qualifier % string() | #'UserNotice'{} + }. + +#'UserNotice'{ + noticeRef, % #'NoticeReference'{} + explicitText % string() + }. + +#'NoticeReference'{ + organization, % string() + noticeNumbers % [integer()] + }. + +#'PolicyMappings_SEQOF'{ + issuerDomainPolicy, % oid() + subjectDomainPolicy % oid() + }. + +#'Attribute'{ + type, % oid() + values % [der_encoded()] + }). + +#'BasicConstraints'{ + cA, % boolean() + pathLenConstraint % integer() + }). + +#'NameConstraints'{ + permittedSubtrees, % [#'GeneralSubtree'{}] + excludedSubtrees % [#'GeneralSubtree'{}] + }). + +#'GeneralSubtree'{ + base, % general_name() + minimum, % integer() + maximum % integer() + }). + +#'PolicyConstraints'{ + requireExplicitPolicy, % integer() + inhibitPolicyMapping % integer() + }). + +#'DistributionPoint'{ + distributionPoint, % {fullName, [general_name()]} | {nameRelativeToCRLIssuer, + [#AttributeTypeAndValue{}]} + reasons, % [dist_reason()] + cRLIssuer % [general_name()] + }). + +
+ +
+ + Private Internet Extensions + +

The private internet extensions OID name atoms and their corresponding value + types are as follows:

+ + + + OID Name + Value Type + + + id-pe-authorityInfoAccess + [#'AccessDescription'{}] + + + id-pe-subjectInfoAccess + [#'AccessDescription'{}] + + Private Internet Extensions +
+ + +#'AccessDescription'{ + accessMethod, % oid() + accessLocation % general_name() + }). + +
- - +
+ CRL and CRL Extensions Profile + +

Erlang representation of CRL and CRL extensions profile + derived from ASN.1 specifications and RFC 5280 are as follows:

+ + +#'CertificateList'{ + tbsCertList, % #'TBSCertList{} + signatureAlgorithm, % #'AlgorithmIdentifier'{} + signature % {0, binary()} - ASN1 compact bitstring + }). + +#'TBSCertList'{ + version, % v2 (if defined) + signature, % #AlgorithmIdentifier{} + issuer, % {rdnSequence, [#AttributeTypeAndValue'{}]} + thisUpdate, % time() + nextUpdate, % time() + revokedCertificates, % [#'TBSCertList_revokedCertificates_SEQOF'{}] + crlExtensions % [#'Extension'{}] + }). + +#'TBSCertList_revokedCertificates_SEQOF'{ + userCertificate, % integer() + revocationDate, % timer() + crlEntryExtensions % [#'Extension'{}] + }). - +
+ + CRL Extensions + +

The CRL extensions OID name atoms and their corresponding value types are as follows:

+ + + + + OID Name + Value Type + + + id-ce-authorityKeyIdentifier + #'AuthorityKeyIdentifier{} + + + id-ce-issuerAltName + {rdnSequence, [#AttributeTypeAndValue'{}]} + + + id-ce-cRLNumber + integer() + + + id-ce-deltaCRLIndicator + integer() + + + id-ce-issuingDistributionPoint + #'IssuingDistributionPoint'{} + + + id-ce-freshestCRL + [#'Distributionpoint'{}] + + + CRL Extensions +
+ +

Here, the data type 'IssuingDistributionPoint' is represented as + the following Erlang record:

+ + +#'IssuingDistributionPoint'{ + distributionPoint, % {fullName, [general_name()]} | {nameRelativeToCRLIssuer, + [#AttributeTypeAndValue'{}]} + onlyContainsUserCerts, % boolean() + onlyContainsCACerts, % boolean() + onlySomeReasons, % [dist_reason()] + indirectCRL, % boolean() + onlyContainsAttributeCerts % boolean() + }). +
+ +
+ + CRL Entry Extensions + +

The CRL entry extensions OID name atoms and their corresponding value types are as follows:

+ + + + OID Name + Value Type + + + id-ce-cRLReason + crl_reason() + + + id-ce-holdInstructionCode + oid() + + + id-ce-invalidityDate + general_time() + + + id-ce-certificateIssuer + general_name() + + CRL Entry Extensions +
+ + +

Here:

+ + crl_reason() + =

unspecifiedc>

+

| keyCompromise

+

| cACompromise

+

| affiliationChanged

+

| superseded

+

| cessationOfOperation

+

| certificateHold

+

| removeFromCRL

+

| privilegeWithdrawn

+

| aACompromise

+ + + +
+ +
+ + PKCS#10 Certification Request +

Erlang representation of a PKCS#10 certification request + derived from ASN.1 specifications and RFC 5280 are as follows:

+ +#'CertificationRequest'{ + certificationRequestInfo #'CertificationRequestInfo'{}, + signatureAlgorithm #'CertificationRequest_signatureAlgorithm'{}}. + signature {0, binary()} - ASN1 compact bitstring + } + +#'CertificationRequestInfo'{ + version atom(), + subject {rdnSequence, [#AttributeTypeAndValue'{}]} , + subjectPKInfo #'CertificationRequestInfo_subjectPKInfo'{}, + attributes [#'AttributePKCS-10' {}] + } + +#'CertificationRequestInfo_subjectPKInfo'{ + algorithm #'CertificationRequestInfo_subjectPKInfo_algorithm'{} + subjectPublicKey {0, binary()} - ASN1 compact bitstring + } + +#'CertificationRequestInfo_subjectPKInfo_algorithm'{ + algorithm = oid(), + parameters = der_encoded() +} + +#'CertificationRequest_signatureAlgorithm'{ + algorithm = oid(), + parameters = der_encoded() + } +#'AttributePKCS-10'{ + type = oid(), + values = [der_encoded()] +} +
+
+ -- cgit v1.2.3 From d34eab98d034598f2e9ed96c8e3aa992cb633bc8 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Thu, 7 May 2015 13:29:16 +0200 Subject: public_key: Correct application names and typos --- lib/public_key/doc/src/introduction.xml | 10 +++++----- lib/public_key/doc/src/public_key.xml | 12 ++++++------ lib/public_key/doc/src/records.xml | 6 +++--- lib/public_key/doc/src/using_public_key.xml | 25 +++++++++++++------------ 4 files changed, 27 insertions(+), 26 deletions(-) (limited to 'lib') diff --git a/lib/public_key/doc/src/introduction.xml b/lib/public_key/doc/src/introduction.xml index 17f4e5155a..6542c8c509 100644 --- a/lib/public_key/doc/src/introduction.xml +++ b/lib/public_key/doc/src/introduction.xml @@ -5,7 +5,7 @@
2008 - 2013 + 2015 Ericsson AB, All Rights Reserved @@ -36,7 +36,7 @@
Purpose -

The public_key application deals with public-key related file +

The Public Key application deals with public-key related file formats, digital signatures, and X-509 certificates. It is a library application that provides encode/decode, sign/verify, encrypt/decrypt, and similar @@ -54,9 +54,9 @@

Performance Tips -

The public_key decode- and encode-functions try to use the NIFs - in the ASN.1 compilers runtime modules, if they can be found. - Thus, to have the ASN.1 application in the +

The Public Key decode- and encode-functions try to use the NIFs + in the ASN.1 compilers runtime modules, if they can be found. + Thus, to have the ASN1 application in the path of your system gives the best performance.

diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index 3d5c135075..8a81593341 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -43,9 +43,9 @@ public_key - public_key requires the crypto and ASN.1 applications, - the latter as OTP R16 (hopefully the runtime dependency on ASN.1 will - be removed again in the future). + Public Key requires the Crypto and ASN1 applications, + the latter as OTP R16 (hopefully the runtime dependency on ASN1 will + be removed again in the future). Supports RFC 5280 - Internet X.509 Public-Key Infrastructure Certificate and Certificate Revocation List @@ -268,7 +268,7 @@ Decodes a public-key ASN.1 DER encoded entity. Asn1Type = atom() - ASN.1 type present in the public_key applications + ASN.1 type present in the Public Key applications ASN.1 specifications. Der = der_encoded() @@ -282,7 +282,7 @@ Encodes a public-key entity with ASN.1 DER encoding. Asn1Type = atom() - ASN.1 type present in the public_key applications + ASN.1 type present in the Public Key applications ASN.1 specifications. Entity = term() Erlang representation of Asn1Type @@ -626,7 +626,7 @@ fun(OtpCert :: #'OTPCertificate'{},

The fun uses the information in the distribution point to access the latest possible version of the CRL. If this fun is not specified, - public_key uses the default implementation: + Public Key uses the default implementation:

fun(_DP, CRL) -> CRL end diff --git a/lib/public_key/doc/src/records.xml b/lib/public_key/doc/src/records.xml index ac1ecd176c..0090278da8 100644 --- a/lib/public_key/doc/src/records.xml +++ b/lib/public_key/doc/src/records.xml @@ -5,7 +5,7 @@
2008 - 2014 + 2015 Ericsson AB, All Rights Reserved @@ -50,7 +50,7 @@

Common non-standard Erlang data types used to describe the record fields in the - following sections and which are not defined in the public_key Reference Manual follows here:

@@ -772,7 +772,7 @@ are as follows:

Here:

crl_reason() - =

unspecifiedc>

+ =

unspecified

| keyCompromise

| cACompromise

| affiliationChanged

diff --git a/lib/public_key/doc/src/using_public_key.xml b/lib/public_key/doc/src/using_public_key.xml index 69b8c0dcb9..aaf802cd34 100644 --- a/lib/public_key/doc/src/using_public_key.xml +++ b/lib/public_key/doc/src/using_public_key.xml @@ -30,8 +30,8 @@

This section describes examples of how to use the - public_key API. Keys and certificates used in the following - sections are generated only for testing the public_key + Public Key API. Keys and certificates used in the following + sections are generated only for testing the Public Key application.

Some shell printouts in the following examples @@ -43,14 +43,15 @@

Public-key data (keys, certificates, and so on) can be stored in Privacy Enhanced Mail (PEM) format. The PEM files have the following structure:

- - <text> - -----BEGIN <SOMETHING>----- - <Attribute> : <Value> - <Base64 encoded DER data> - -----END <SOMETHING>----- - <text> - + + + <text> + -----BEGIN <SOMETHING>----- + <Attribute> : <Value> + <Base64 encoded DER data> + -----END <SOMETHING>----- + <text> +

A file can contain several BEGIN/END blocks. Text lines between blocks are ignored. Attributes, if present, are ignored except for Proc-Type and DEK-Info, which are used when DER @@ -59,7 +60,7 @@

DSA Private Key

A DSA private key can look as follows:

-

File handling is not done by the public_key application.

 +

File handling is not done by the Public Key application.

 1> {ok, PemBin} = file:read_file("dsa.pem"). {ok,<<"-----BEGIN DSA PRIVATE KEY-----\nMIIBuw"...>>} @@ -364,7 +365,7 @@ ok
RSA Public-Key Cryptography -

Suppose you have the followwing private key and a corresponding public key:

+

Suppose you have the following private key and a corresponding public key:

PrivateKey = #'RSAPrivateKey{}' and the plaintext Msg = binary() -- cgit v1.2.3 From 9a6b0809ceae80bfb542ee8bab2e8fcd12087467 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Thu, 7 May 2015 13:37:16 +0200 Subject: public_key: Align to alphabetical order --- lib/public_key/doc/src/public_key.xml | 54 +++++++++++++++++------------------ 1 file changed, 27 insertions(+), 27 deletions(-) (limited to 'lib') diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml index 8a81593341..6d220c9b69 100644 --- a/lib/public_key/doc/src/public_key.xml +++ b/lib/public_key/doc/src/public_key.xml @@ -292,6 +292,33 @@ + + encrypt_private(PlainText, Key) -> binary() + Public-key encryption using the private key. + + PlainText = binary() + Key = rsa_private_key() + + +

Public-key encryption using the private key. + See also crypto:private_encrypt/4.

+ + + + + encrypt_public(PlainText, Key) -> binary() + Public-key encryption using the public key. + + PlainText = binary() + Key = rsa_public_key() + + +

Public-key encryption using the public key. See also crypto:public_encrypt/4.

+ + + generate_key(Params) -> {Public::binary(), Private::binary()} | #'ECPrivateKey'{} Generates a new keypair. @@ -364,33 +391,6 @@

Creates a PEM entry that can be feed to pem_encode/1.

 - - - encrypt_private(PlainText, Key) -> binary() - Public-key encryption using the private key. - - PlainText = binary() - Key = rsa_private_key() - - -

Public-key encryption using the private key. - See also crypto:private_encrypt/4.

- - - - - encrypt_public(PlainText, Key) -> binary() - Public-key encryption using the public key. - - PlainText = binary() - Key = rsa_public_key() - - -

Public-key encryption using the public key. See also crypto:public_encrypt/4.

- - pkix_decode_cert(Cert, otp|plain) -> #'Certificate'{} | #'OTPCertificate'{} -- cgit v1.2.3 From fafd888770d16d2a3962210c04a0b341311a13c8 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Thu, 7 May 2015 13:59:44 +0200 Subject: public_key: Align types with removal of legacy ASN.1 flags --- lib/public_key/doc/src/records.xml | 20 ++++++++++---------- lib/public_key/doc/src/using_public_key.xml | 8 +++----- 2 files changed, 13 insertions(+), 15 deletions(-) (limited to 'lib') diff --git a/lib/public_key/doc/src/records.xml b/lib/public_key/doc/src/records.xml index 0090278da8..e9e9b231af 100644 --- a/lib/public_key/doc/src/records.xml +++ b/lib/public_key/doc/src/records.xml @@ -160,7 +160,7 @@ #'ECPrivateKey'{ version, % integer() - privateKey, % octet_string() + privateKey, % binary() parameters, % der_encoded() - {'EcpkParameters', #'ECParameters'{}} | {'EcpkParameters', {namedCurve, oid()}} | {'EcpkParameters', 'NULL'} % Inherited by CA @@ -171,14 +171,14 @@ version, % integer() fieldID, % #'FieldID'{} curve, % #'Curve'{} - base, % octet_string() + base, % binary() order, % integer() cofactor % integer() }. #'Curve'{ - a, % octet_string() - b, % octet_string() + a, % binary() + b, % binary() seed % bitstring() - optional }. @@ -189,7 +189,7 @@ }. #'ECPoint'{ - point % octet_string() - the public key + point % binary() - the public key }.
@@ -201,7 +201,7 @@ #'Certificate'{ tbsCertificate, % #'TBSCertificate'{} signatureAlgorithm, % #'AlgorithmIdentifier'{} - signature % {0, binary()} - ASN1 compact bitstring + signature % bitstring() }. #'TBSCertificate'{ @@ -226,7 +226,7 @@ #'OTPCertificate'{ tbsCertificate, % #'OTPTBSCertificate'{} signatureAlgorithm, % #'SignatureAlgorithm' - signature % {0, binary()} - ASN1 compact bitstring + signature % bitstring() }. #'OTPTBSCertificate'{ @@ -664,7 +664,7 @@ are as follows:

#'CertificateList'{ tbsCertList, % #'TBSCertList{} signatureAlgorithm, % #'AlgorithmIdentifier'{} - signature % {0, binary()} - ASN1 compact bitstring + signature % bitstring() }). #'TBSCertList'{ @@ -796,7 +796,7 @@ are as follows:

#'CertificationRequest'{ certificationRequestInfo #'CertificationRequestInfo'{}, signatureAlgorithm #'CertificationRequest_signatureAlgorithm'{}}. - signature {0, binary()} - ASN1 compact bitstring + signature bitstring() } #'CertificationRequestInfo'{ @@ -808,7 +808,7 @@ are as follows:

#'CertificationRequestInfo_subjectPKInfo'{ algorithm #'CertificationRequestInfo_subjectPKInfo_algorithm'{} - subjectPublicKey {0, binary()} - ASN1 compact bitstring + subjectPublicKey bitstring() } #'CertificationRequestInfo_subjectPKInfo_algorithm'{ diff --git a/lib/public_key/doc/src/using_public_key.xml b/lib/public_key/doc/src/using_public_key.xml index aaf802cd34..41a81b6dea 100644 --- a/lib/public_key/doc/src/using_public_key.xml +++ b/lib/public_key/doc/src/using_public_key.xml @@ -212,9 +212,8 @@ algorithm = {1,2,840,113549,1,1,5}, parameters = <<5,0>>}, signature = - {0, - <<163,186,7,163,216,152,63,47,154,234,139,73,154,96,120, - 165,2,52,196,195,109,167,192,...>>}} + <<163,186,7,163,216,152,63,47,154,234,139,73,154,96,120, + 165,2,52,196,195,109,167,192,...>>}

Parts of certificates can be decoded with public_key:der_decode/2, using the ASN.1 type of that part. @@ -317,9 +316,8 @@ algorithm = {1,2,840,113549,1,1,5}, parameters = 'NULL'}, signature = - {0, <<163,186,7,163,216,152,63,47,154,234,139,73,154,96,120, - 165,2,52,196,195,109,167,192,...>>}} + 165,2,52,196,195,109,167,192,...>>}

This call is equivalent to public_key:pem_entry_decode(CertEntry1):

5> public_key:pkix_decode_cert(DerCert, plain). -- cgit v1.2.3 From 631489eb5f989f06de993004ae6db58f07465ccb Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Thu, 7 May 2015 14:09:35 +0200 Subject: public_key: Add clarifications --- lib/public_key/doc/src/records.xml | 17 ++++++++++++++--- lib/public_key/doc/src/using_public_key.xml | 4 +++- 2 files changed, 17 insertions(+), 4 deletions(-) (limited to 'lib') diff --git a/lib/public_key/doc/src/records.xml b/lib/public_key/doc/src/records.xml index e9e9b231af..9536167839 100644 --- a/lib/public_key/doc/src/records.xml +++ b/lib/public_key/doc/src/records.xml @@ -96,6 +96,15 @@

| privilegeWithdrawn

| aACompromise

+ + OID_macro() + =

?OID_name()

+ + + OID_name() + =

atom()

+ +
@@ -196,7 +205,7 @@
PKIX Certificates

Erlang representation of PKIX certificates derived from ASN.1 - specifications see also X509 certificates (RFC 5280) are as follows:

+ specifications see also X509 certificates (RFC 5280), also referred to as plain type, are as follows:

#'Certificate'{ tbsCertificate, % #'TBSCertificate'{} @@ -222,6 +231,8 @@ parameters % der_encoded() }. +

Erlang alternate representation of PKIX certificate, also referred to as otp type

+ #'OTPCertificate'{ tbsCertificate, % #'OTPTBSCertificate'{} @@ -247,8 +258,8 @@ parameters % asn1_novalue | #'Dss-Parms'{} }. -

Here, id_signature_algorithm() = ?OID name, for available OID names, for example -?id-dsa-with-sha1. That is, by prepending "?" to the OID name, represented as an Erlang atom.

+

id_signature_algorithm() = OID_macro()

+

The available OID names are as follows:

diff --git a/lib/public_key/doc/src/using_public_key.xml b/lib/public_key/doc/src/using_public_key.xml index 41a81b6dea..03e4bedf3d 100644 --- a/lib/public_key/doc/src/using_public_key.xml +++ b/lib/public_key/doc/src/using_public_key.xml @@ -381,7 +381,9 @@ Msg = public_key:decrypt_public(RsaEncrypted, PublicKey), Msg = public_key:decrypt_private(RsaEncrypted, PrivateKey),

You normally do only one of the encrypt or decrypt operations, - and the peer does the other.

 + and the peer does the other. This normaly used in legacy applications + as a primitive digital signature. +

-- cgit v1.2.3 From e95095457c4d83c02850b811fb28711c0b3d1c23 Mon Sep 17 00:00:00 2001 From: xsipewe Date: Tue, 14 Apr 2015 23:21:36 +0200 Subject: Update asn1 documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Language cleaned up by the technical writers xsipewe and tmanevik from Combitech. Proofreading and corrections by Björn Gustavsson. --- lib/asn1/doc/src/Makefile | 4 +- lib/asn1/doc/src/asn1_getting_started.xml | 1290 ++++++++++++++++++++++++++ lib/asn1/doc/src/asn1_introduction.xml | 99 ++ lib/asn1/doc/src/asn1_overview.xml | 49 + lib/asn1/doc/src/asn1_spec.xmlsrc | 521 ++++++----- lib/asn1/doc/src/asn1_ug.xml | 1417 ----------------------------- lib/asn1/doc/src/asn1ct.xml | 316 +++---- lib/asn1/doc/src/asn1rt.xml | 26 +- lib/asn1/doc/src/part.xml | 9 +- lib/asn1/doc/src/ref_man.xml | 6 +- 10 files changed, 1898 insertions(+), 1839 deletions(-) create mode 100644 lib/asn1/doc/src/asn1_getting_started.xml create mode 100644 lib/asn1/doc/src/asn1_introduction.xml create mode 100644 lib/asn1/doc/src/asn1_overview.xml delete mode 100644 lib/asn1/doc/src/asn1_ug.xml (limited to 'lib') diff --git a/lib/asn1/doc/src/Makefile b/lib/asn1/doc/src/Makefile index 3b3e1bd8f9..f26508295c 100644 --- a/lib/asn1/doc/src/Makefile +++ b/lib/asn1/doc/src/Makefile @@ -48,7 +48,9 @@ XML_HTML_FILE = \ notes_history.xml XML_CHAPTER_FILES = \ - asn1_ug.xml \ + asn1_introduction.xml \ + asn1_getting_started.xml \ + asn1_overview.xml \ asn1_spec.xml \ notes.xml diff --git a/lib/asn1/doc/src/asn1_getting_started.xml b/lib/asn1/doc/src/asn1_getting_started.xml new file mode 100644 index 0000000000..1a9c279191 --- /dev/null +++ b/lib/asn1/doc/src/asn1_getting_started.xml @@ -0,0 +1,1290 @@ + + + + +
+ + 19972013 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + Getting Started + Kenneth Lundin + + 1999-03-25 + D + asn1_getting_started.xml +
+ +
+ Example +

The following example demonstrates the basic functionality used to + run the Erlang ASN.1 compiler.

+

Create a file named People.asn containing the following:

+ 
+People DEFINITIONS AUTOMATIC TAGS ::=
+BEGIN
+  Person ::= SEQUENCE {
+    name PrintableString,
+    location INTEGER {home(0),field(1),roving(2)},
+    age INTEGER OPTIONAL
+  }
+END
+

This file must be compiled before it can be used. + The ASN.1 compiler checks that the syntax is correct and that the + text represents proper ASN.1 code before generating an abstract + syntax tree. The code-generator then uses the abstract syntax + tree to generate code.

+

The generated Erlang files are placed in the current directory or + in the directory specified with option {outdir,Dir}.

+

The following shows how the compiler + can be called from the Erlang shell:

+ + 
+1> asn1ct:compile("People", [ber]).
+ok
+2>
+ +

Option verbose can be added to get information + about the generated files:

+ 
+2> asn1ct:compile("People", [ber,verbose]).
+Erlang ASN.1 compiling "People.asn" 
+--{generated,"People.asn1db"}--
+--{generated,"People.hrl"}--
+--{generated,"People.erl"}--
+ok
+3>
+ +

ASN.1 module People is now accepted and the + abstract syntax tree is saved in file People.asn1db. + The generated Erlang code is compiled using the Erlang compiler + and loaded into the Erlang runtime system. There is now an API + for encode/2 and decode/2 in module + People, which is called like:

+ , )]]> +

+ or

+, )]]>

+ +

Assume that there is a network + application that receives instances of the ASN.1 defined + type Person, modifies, and sends them back again:

+ + +receive + {Port,{data,Bytes}} -> + case 'People':decode('Person',Bytes) of + {ok,P} -> + {ok,Answer} = 'People':encode('Person',mk_answer(P)), + Port ! {self(),{command,Answer}}; + {error,Reason} -> + exit({error,Reason}) + end + end, +

In this example, a series of bytes is received from an + external source and the bytes are then decoded into a valid + Erlang term. This was achieved with the call + 'People':decode('Person',Bytes), which returned + an Erlang value of the ASN.1 type Person. Then an answer was + constructed and encoded using + 'People':encode('Person',Answer), which takes an + instance of a defined ASN.1 type and transforms it to a + binary according to the BER or PER encoding rules.

+

The encoder and decoder can also be run from the shell:

+ 
+2> Rockstar = {'Person',"Some Name",roving,50}.
+{'Person',"Some Name",roving,50}
+3> {ok,Bin} = 'People':encode('Person',Rockstar).
+{ok,<<243,17,19,9,83,111,109,101,32,78,97,109,101,2,1,2,
+      2,1,50>>}
+4> {ok,Person} = 'People':decode('Person',Bin).
+{ok,{'Person',"Some Name",roving,50}}
+5>
+ +
+ Module Dependencies +

It is common that ASN.1 modules import defined types, values, and + other entities from another ASN.1 module.

+

Earlier versions of the ASN.1 compiler required that modules + that were imported from had to be compiled before the module + that imported. This caused problems when ASN.1 modules had circular + dependencies.

+

Referenced modules are now parsed when the compiler finds an + entity that is imported. No code is generated for + the referenced module. However, the compiled modules rely on + that the referenced modules are also compiled.

+
+
+ +
+ ASN.1 Application User Interface +

The ASN.1 application provides the following two + separate user interfaces:

+ + +

The module asn1ct, which provides the compile-time functions + (including the compiler)

+ + +

The module asn1rt_nif, which provides the runtime functions + for the ASN.1 decoder for the BER back end

+ + +

The reason for this division of the interfaces into compile-time + and runtime + is that only runtime modules (asn1rt*) need to be loaded in + an embedded system. +

+ +
+ Compile-Time Functions +

The ASN.1 compiler can be started directly from the command line + by the erlc program. This is convenient when compiling + many ASN.1 files from the command line or when using Makefiles. + Some examples of how the erlc command can be used to start + the ASN.1 compiler:

+ 
+erlc Person.asn
+erlc -bper Person.asn
+erlc -bber ../Example.asn
+erlc -o ../asnfiles -I ../asnfiles -I /usr/local/standards/asn1 Person.asn
+

Useful options for the ASN.1 compiler:

+ + -b[ber | per | uper] + +

Choice of encoding rules. If omitted, ber is the + default.

+ + -o OutDirectory + +

Where to put the generated files. Default is the current + directory.

+ + -I IncludeDir + +

Where to search for .asn1db files and ASN.1 + source specs to resolve references to other + modules. This option can be repeated many times if there + are several places to search in. The compiler + searches the current directory first.

+ + +der + +

DER encoding rule. Only when using option -ber.

+ + +asn1config + +

This functionality works together with option + ber. It enables the specialized decodes, see Section + Specialized Decode.

+ + +undec_rest + +

A buffer that holds a message being decoded can also have + trailing bytes. If those trailing bytes are important, they + can be returned along with the decoded value by compiling + the ASN.1 specification with option +undec_rest. + The return value from the decoder is + {ok,Value,Rest} where Rest is a binary + containing the trailing bytes.

+ + +'Any Erlc Option' + +

Any option can be added to the Erlang compiler when + compiling the generated Erlang files. Any option + unrecognized by the ASN.1 compiler is passed to the + Erlang compiler.

+ + +

For a complete description of erlc, see + ERTS Reference Manual.

+

The compiler and other compile-time functions can also be started + from the Erlang shell. Here follows a brief + description of the primary functions. For a + complete description of each function, see module asn1ct in + the ASN.1 Reference Manual.

+

The compiler is started by asn1ct:compile/1 with + default options, or asn1ct:compile/2 if explicit options + are given.

+

Example:

+ 
+asn1ct:compile("H323-MESSAGES.asn1").
+

This equals:

+ 
+asn1ct:compile("H323-MESSAGES.asn1",[ber]).
+

If PER encoding is wanted:

+ 
+asn1ct:compile("H323-MESSAGES.asn1",[per]).
+

The generic encode and decode functions can be called + as follows:

+ 
+'H323-MESSAGES':encode('SomeChoiceType',{call,<<"octetstring">>}).
+'H323-MESSAGES':decode('SomeChoiceType',Bytes).
+
+ +
+ Runtime Functions +

When an ASN.1 specification is compiled with option ber, + the asn1rt_nif module and the NIF library in + asn1/priv_dir are needed at runtime.

+

By calling function info/0 in a generated module, you + get information about which compiler options were used.

+
+ +
+ Errors +

Errors detected at + compile-time are displayed on the screen together with line + numbers indicating where in the source file the respective error + was detected. If no errors are found, an Erlang ASN.1 module is + created.

+

The runtime encoders and decoders execute within a catch and + return {ok, Data} or + {error, {asn1, Description}} where + Description is + an Erlang term describing the error.

+
+
+ +
+ + Multi-File Compilation +

There are various reasons for using multi-file compilation:

+ + To choose the name for the generated module, for + example, because you need to compile the same specs for + different encoding rules. + You want only one resulting module. + +

Specify which ASN.1 specs to compile in a module with extension + .set.asn. Choose a module name and provide the + names of the ASN.1 specs. For example, if you have the specs + File1.asn, File2.asn, and File3.asn, your + module MyModule.set.asn looks as follows:

+ 
+File1.asn
+File2.asn
+File3.asn
+

If you compile with the following, the result is one merged + module MyModule.erl with the generated code from the three + ASN.1 specs:

+ +~> erlc MyModule.set.asn +
+ +
+ Remark about Tags + +

Tags used to be important for all users of ASN.1, because it + was necessary to add tags manually to certain constructs in order + for the ASN.1 specification to be valid. Example of + an old-style specification:

+ + 
+Tags DEFINITIONS ::=
+BEGIN
+  Afters ::= CHOICE { cheese [0] IA5String,
+                      dessert [1] IA5String }
+END
+ +

Without the tags (the numbers in square brackets) the ASN.1 + compiler refused to compile the file.

+ +

In 1994 the global tagging mode AUTOMATIC TAGS was introduced. + By putting AUTOMATIC TAGS in the module header, the ASN.1 + compiler automatically adds tags when needed. The following is the + same specification in AUTOMATIC TAGS mode:

+ + 
+Tags DEFINITIONS AUTOMATIC TAGS ::=
+BEGIN
+  Afters ::= CHOICE { cheese IA5String,
+                      dessert IA5String }
+END
+ +

Tags are not mentioned any more in this User's Guide.

+
+ +
+ + ASN.1 Types +

This section describes the ASN.1 types including their + functionality, purpose, and how values are assigned in Erlang. +

+

ASN.1 has both primitive and constructed types:

+

+
+ + Primitive Types + Constructed Types + + + BOOLEAN + SEQUENCE + + + INTEGER + SET + + + REAL + CHOICE + + + NULL + SET OF and SEQUENCE OF + + + ENUMERATED + ANY + + + BIT STRING + ANY DEFINED BY + + + OCTET STRING + EXTERNAL + + + Character Strings + EMBEDDED PDV + + + OBJECT IDENTIFIER + CHARACTER STRING + + + Object Descriptor + + + + TIME Types + + + Supported ASN.1 Types +
+ + +

The values of each ASN.1 type have their own representation in Erlang, as + described in the following sections. Users must provide + these values for encoding according to the representation, as shown in the + following example:

+ + 
+Operational ::= BOOLEAN --ASN.1 definition
+

In Erlang code it can look as follows:

+ 
+Val = true,
+{ok,Bytes} = MyModule:encode('Operational', Val),
+ +
+ + BOOLEAN +

Booleans in ASN.1 express values that can be either + TRUE or FALSE. + The meanings assigned to TRUE and FALSE are outside the scope + of this text.

+

In ASN.1 it is possible to have:

+ 
+Operational ::= BOOLEAN
+

Assigning a value to type Operational in Erlang is possible by + using the following Erlang code:

+ +Myvar1 = true, +

Thus, in Erlang the atoms true and false are used + to encode a boolean value.

+
+ +
+ + INTEGER +

ASN.1 itself specifies indefinitely large integers. Erlang + systems with version 4.3 and higher support very large + integers, in practice indefinitely large integers.

+

The concept of subtyping can be applied to integers and + to other ASN.1 types. The details of subtyping are not + explained here; for more information, see X.680. Various + syntaxes are allowed when defining a type as an integer:

+ 
+T1 ::= INTEGER
+T2 ::= INTEGER (-2..7)
+T3 ::= INTEGER (0..MAX)
+T4 ::= INTEGER (0<..MAX)
+T5 ::= INTEGER (MIN<..-99)
+T6 ::= INTEGER {red(0),blue(1),white(2)}
+

The Erlang representation of an ASN.1 INTEGER is an integer or + an atom if a Named Number List (see T6 in the previous + list) is specified.

+

The following is an example of Erlang code that assigns values for the + types in the previous list:

+ 
+T1value = 0,
+T2value = 6,
+T6value1 = blue,
+T6value2 = 0,
+T6value3 = white
+

These Erlang variables are now bound to valid instances of + ASN.1 defined types. This style of value can be passed directly + to the encoder for transformation into a series of bytes.

+

The decoder returns an atom if the value corresponds to a + symbol in the Named Number List.

+
+ +
+ + REAL +

The following ASN.1 type is used for real numbers:

+ 
+R1 ::= REAL
+

It is assigned a value in Erlang as follows:

+ 
+R1value1 = "2.14",
+R1value2 = {256,10,-2},
+

In the last line, notice that the tuple {256,10,-2} is the real number + 2.56 in a special notation, which encodes faster than simply + stating the number as "2.56". The arity three tuple is + {Mantissa,Base,Exponent}, that is, Mantissa * Base^Exponent.

+
+ +
+ + NULL +

The type NULL is suitable where supply and recognition of a value + is important but the actual value is not.

+ 
+Notype ::= NULL
+

This type is assigned in Erlang as follows:

+ 
+N1 = 'NULL',
+

The actual value is the quoted atom 'NULL'.

+
+ +
+ + ENUMERATED +

The type ENUMERATED can be used when the value you want to + describe can only take one of a set of predefined values. Example:

+ 
+DaysOfTheWeek ::= ENUMERATED { 
+    sunday(1),monday(2),tuesday(3),
+    wednesday(4),thursday(5),friday(6),saturday(7) }
+

For example, to assign a weekday value in Erlang, use the same atom + as in the Enumerations of the type definition:

+ 
+Day1 = saturday,
+

The enumerated type is similar to an integer type, when + defined with a set of predefined values. The difference is that + an enumerated type can only have specified + values, whereas an integer can have any value.

+
+ +
+ + BIT STRING +

The type BIT STRING can be used to model information that + is made up of arbitrary length series of bits. It is intended + to be used for selection of flags, not for binary files.

+

In ASN.1, BIT STRING definitions can look as follows:

+ 
+Bits1 ::= BIT STRING
+Bits2 ::= BIT STRING {foo(0),bar(1),gnu(2),gnome(3),punk(14)}
+

The following two notations are available for representation of BIT + STRING values in Erlang and as input to the encode functions:

+ + A bitstring. By default, a BIT STRING with no + symbolic names is decoded to an Erlang bitstring. + A list of atoms corresponding to atoms in the NamedBitList + in the BIT STRING definition. A BIT STRING with symbolic + names is always decoded to the format shown in the following + example: + + 
+Bits1Val1 = <<0:1,1:1,0:1,1:1,1:1>>,
+Bits2Val1 = [gnu,punk],
+Bits2Val2 = <<2#1110:4>>,
+Bits2Val3 = [bar,gnu,gnome],
+

Bits2Val2 and Bits2Val3 denote the same value.

+

Bits2Val1 is assigned symbolic values. The assignment means + that the bits corresponding to gnu and punk, that is, bits + 2 and 14 are set to 1, and the rest are set to 0. The symbolic values + are shown as a list of values. If a named value, which is not + specified in the type definition, is shown, a runtime error occurs.

+

BIT STRINGs can also be subtyped with, for example, a SIZE + specification:

+ 
+Bits3 ::= BIT STRING (SIZE(0..31))
+

This means that no bit higher than 31 can be set.

+ +
+ Deprecated Representations for BIT STRING +

In addition to the representations described earlier, the + following deprecated representations are available if the + specification has been compiled with option + legacy_erlang_types:

+ + Aa a list of binary digits (0 or 1). This format is + accepted as input to the encode functions, and a BIT STRING + is decoded to this format if option + legacy_bit_string is given. + + As {Unused,Binary} where Unused denotes + how many trailing zero-bits 0-7 that are unused in the + least significant byte in Binary. This format is + accepted as input to the encode functions, and a BIT + STRING is decoded to this format if + compact_bit_string has been given. + + As a hexadecimal number (or an integer). Avoid this + as it is easy to misinterpret a BIT + STRING value in this format. + + +
+
+ +
+ + OCTET STRING +

OCTET STRING is the simplest of all ASN.1 types. OCTET + STRING only moves or transfers, for example, binary files or other + unstructured information complying with two rules: the + bytes consist of octets and encoding is not required.

+

It is possible to have the following ASN.1 type definitions:

+ 
+O1 ::= OCTET STRING
+O2 ::= OCTET STRING (SIZE(28))
+

With the following example assignments in Erlang:

+ 
+O1Val = <<17,13,19,20,0,0,255,254>>,
+O2Val = <<"must be exactly 28 chars....">>,
+

By default, an OCTET STRING is always represented as + an Erlang binary. If the specification has been compiled with + option legacy_erlang_types, the encode functions + accept both lists and binaries, and the decode functions + decode an OCTET STRING to a list.

+
+ +
+ + Character Strings +

ASN.1 supports a wide variety of character sets. The main difference + between an OCTET STRING and a character string is that the + OCTET STRING has no imposed semantics on the bytes delivered.

+

However, when using, for example, IA5String (which closely + resembles ASCII), byte 65 (in decimal + notation) means character 'A'. +

+

For example, if a defined type is to be a VideotexString and + an octet is received with the unsigned integer value X, + the octet is to be interpreted as specified in standard + ITU-T T.100, T.101. +

+

The ASN.1 to Erlang compiler + does not determine the correct interpretation of each BER + string octet value with different character strings. The + application is responsible for interpretation + of octets. Therefore, from the BER + string point of view, octets are very similar to + character strings and are compiled in the same way. +

+

When PER is + used, there is a significant difference in the encoding scheme + between OCTET STRINGs and other strings. The constraints + specified for a type are especially important for PER, where + they affect the encoding. +

+

Examples:

+ 
+Digs ::= NumericString (SIZE(1..3))
+TextFile ::= IA5String (SIZE(0..64000))
+

The corresponding Erlang assignments:

+ 
+DigsVal1 = "456",
+DigsVal2 = "123",
+TextFileVal1 = "abc...xyz...",
+TextFileVal2 = [88,76,55,44,99,121 .......... a lot of characters here ....]
+

The Erlang representation for "BMPString" and + "UniversalString" is either a list of ASCII values or a list + of quadruples. The quadruple representation associates to the + Unicode standard representation of characters. The ASCII + characters are all represented by quadruples beginning with + three zeros like {0,0,0,65} for character 'A'. When + decoding a value for these strings, the result is a list of + quadruples, or integers when the value is an ASCII character.

+ +

The following example shows how it works. Assume the following + specification is in file PrimStrings.asn1:

+ 
+PrimStrings DEFINITIONS AUTOMATIC TAGS ::=
+BEGIN
+   BMP ::= BMPString
+END
+ +

Encoding and decoding some strings:

+ + 
+1> asn1ct:compile('PrimStrings', [ber]).
+ok
+2> {ok,Bytes1} = 'PrimStrings':encode('BMP', [{0,0,53,53},{0,0,45,56}]).
+{ok,<<30,4,53,54,45,56>>}
+3> 'PrimStrings':decode('BMP', Bytes1).
+{ok,[{0,0,53,53},{0,0,45,56}]}
+4> {ok,Bytes2} = 'PrimStrings':encode('BMP', [{0,0,53,53},{0,0,0,65}]).
+{ok,<<30,4,53,53,0,65>>}
+5> 'PrimStrings':decode('BMP', Bytes2).
+{ok,[{0,0,53,53},65]}
+6> {ok,Bytes3} = 'PrimStrings':encode('BMP', "BMP string").
+{ok,<<30,20,0,66,0,77,0,80,0,32,0,115,0,116,0,114,0,105,0,110,0,103>>}
+7> 'PrimStrings':decode('BMP', Bytes3).
+{ok,"BMP string"}
+ +

Type UTF8String is represented as a UTF-8 encoded binary in + Erlang. Such binaries can be created directly using the binary syntax + or by converting from a list of Unicode code points using function + unicode:characters_to_binary/1.

+ +

The following shows examples of how UTF-8 encoded binaries can + be created and manipulated:

+ 
+1> Gs = "Мой маленький Гном".
+[1052,1086,1081,32,1084,1072,1083,1077,1085,1100,1082,1080,
+ 1081,32,1043,1085,1086,1084]
+2> Gbin = unicode:characters_to_binary(Gs).
+<<208,156,208,190,208,185,32,208,188,208,176,208,187,208,
+  181,208,189,209,140,208,186,208,184,208,185,32,208,147,
+  208,...>>
+3> Gbin = <<"Мой маленький Гном"/utf8>>.
+<<208,156,208,190,208,185,32,208,188,208,176,208,187,208,
+  181,208,189,209,140,208,186,208,184,208,185,32,208,147,
+  208,...>>
+4> Gs = unicode:characters_to_list(Gbin).
+[1052,1086,1081,32,1084,1072,1083,1077,1085,1100,1082,1080,
+ 1081,32,1043,1085,1086,1084]
+ +

For details, see the unicode + module in stdlib.

+ +

In the following example, this ASN.1 specification is used:

+ 
+UTF DEFINITIONS AUTOMATIC TAGS ::=
+BEGIN
+   UTF ::= UTF8String
+END
+ +

Encoding and decoding a string with Unicode characters:

+ + 
+5> asn1ct:compile('UTF', [ber]).
+ok
+6> {ok,Bytes1} = 'UTF':encode('UTF', <<"Гном"/utf8>>).
+{ok,<<12,8,208,147,208,189,208,190,208,188>>}
+7> {ok,Bin1} = 'UTF':decode('UTF', Bytes1).
+{ok,<<208,147,208,189,208,190,208,188>>}
+8> io:format("~ts\n", [Bin1]).
+Гном
+ok
+9> unicode:characters_to_list(Bin1).
+[1043,1085,1086,1084]
+
+ +
+ + OBJECT IDENTIFIER +

The type OBJECT IDENTIFIER is used whenever a unique identity is + required. An ASN.1 module, a transfer syntax, and so on, is identified + with an OBJECT IDENTIFIER. Assume the following example:

+ 
+Oid ::= OBJECT IDENTIFIER
+

Therefore, the following example is a valid Erlang instance of + type 'Oid':

+ 
+OidVal1 = {1,2,55},
+

The OBJECT IDENTIFIER value is simply a tuple with the + consecutive values, which must be integers. +

+

The first value is limited to the values 0, 1, or 2. The + second value must be in the range 0..39 when the first value + is 0 or 1. +

+

The OBJECT IDENTIFIER is an important type and it is + widely used within different standards to identify various + objects uniquely. Dubuisson: ASN.1 - Communication Between + Heterogeneous Systems includes an + easy-to-understand description of the use of + OBJECT IDENTIFIER.

+
+ +
+ + Object Descriptor +

Values of this type can be assigned a value as an ordinary string + as follows:

+ + 
+      "This is the value of an Object descriptor"
+
+ +
+ + TIME Types +

Two time types are defined within ASN.1: Generalized + Time and Universal Time Coordinated (UTC). Both are assigned a + value as an ordinary string within double quotes, for example, + "19820102070533.8".

+

For DER encoding, the compiler does not check the validity + of the time values. The DER requirements upon those strings are + regarded as a matter for the application to fulfill.

+
+ +
+ + SEQUENCE +

The structured types of ASN.1 are constructed from other types + in a manner similar to the concepts of array and struct in C.

+

A SEQUENCE in ASN.1 is + comparable with a struct in C and a record in Erlang. + A SEQUENCE can be defined as follows:

+ 
+Pdu ::= SEQUENCE {
+   a INTEGER,
+   b REAL,
+   c OBJECT IDENTIFIER,
+   d NULL }
+

This is a 4-component structure called Pdu. The record format + is the major format for representation of SEQUENCE in Erlang. + For each SEQUENCE and SET in an ASN.1 module an Erlang + record declaration is generated. For Pdu, a record + like the following is defined:

+ 
+-record('Pdu',{a, b, c, d}).
+

The record declarations for a module M are placed in a + separate M.hrl file.

+

Values can be assigned in Erlang as follows:

+ 
+MyPdu = #'Pdu'{a=22,b=77.99,c={0,1,2,3,4},d='NULL'}.
+

The decode functions return a record as result when decoding + a SEQUENCE or a SET.

+ +

A SEQUENCE and a SET can contain a component + with a DEFAULT keyword followed by the actual value, which + is the default value. The DEFAULT keyword means that the + application doing the encoding can omit encoding of the value, which + results in fewer bytes to send to the receiving application.

+ +

An application can use the atom asn1_DEFAULT to indicate + that the encoding is to be omitted for that position in + the SEQUENCE.

+ +

Depending on the encoding rules, the encoder can also compare + the given value to the default value and automatically omit the + encoding if the values are equal. How much effort the encoder makes + to compare the values depends on the encoding rules. The DER + encoding rules forbid encoding a value equal to the default value, + so it has a more thorough and time-consuming comparison than the + encoders for the other encoding rules.

+ +

In the following example, this ASN.1 specification is used:

+ 
+File DEFINITIONS AUTOMATIC TAGS ::=
+BEGIN
+Seq1 ::= SEQUENCE {
+    a INTEGER DEFAULT 1,
+    b Seq2 DEFAULT {aa TRUE, bb 15}
+}
+
+Seq2 ::= SEQUENCE {
+    aa BOOLEAN,
+    bb INTEGER
+}
+
+Seq3 ::= SEQUENCE {
+    bs BIT STRING {a(0), b(1), c(2)} DEFAULT {a, c}
+}
+END
+

Example where the BER encoder is able to omit encoding + of the default values:

+ 
+1> asn1ct:compile('File', [ber]).
+ok
+2> 'File':encode('Seq1', {'Seq1',asn1_DEFAULT,asn1_DEFAULT}).
+{ok,<<48,0>>}
+3> 'File':encode('Seq1', {'Seq1',1,{'Seq2',true,15}}).
+{ok,<<48,0>>}
+ +

Example with a named BIT STRING where the BER + encoder does not omit the encoding:

+ 
+4> 'File':encode('Seq3', {'Seq3',asn1_DEFAULT).
+{ok,<<48,0>>}
+5> 'File':encode('Seq3', {'Seq3',<<16#101:3>>).
+{ok,<<48,4,128,2,5,160>>}
+ +

The DER encoder omits the encoding for the same BIT STRING:

+ 
+6> asn1ct:compile('File', [ber,der]).
+ok
+7> 'File':encode('Seq3', {'Seq3',asn1_DEFAULT).
+{ok,<<48,0>>}
+8> 'File':encode('Seq3', {'Seq3',<<16#101:3>>).
+{ok,<<48,0>>}
+
+ +
+ + SET +

In Erlang, the SET type is used exactly as SEQUENCE. + Notice that if BER or DER encoding rules are used, decoding a + SET is slower than decoding a SEQUENCE because the + components must be sorted.

+
+ +
+ Extensibility for SEQUENCE and SET +

When a SEQUENCE or SET contains an extension marker + and extension components as the following, the type can get more + components in newer versions of the ASN.1 spec:

+ 
+SExt ::= SEQUENCE {
+           a INTEGER,
+           ...,
+           b BOOLEAN }
+

In this case it has got a new + component b. Thus, incoming messages that are decoded + can have more or fever components than this one. +

+

The component b is treated as + an original component when encoding a message. In this case, as + it is not an optional element, it must be encoded. +

+

During decoding, the b field of the record gets the decoded + value of the b + component, if present, otherwise the value asn1_NOVALUE.

+
+ +
+ + CHOICE +

The type CHOICE is a space saver and is similar to the + concept of a 'union' in C.

+

Assume the following:

+ 
+SomeModuleName DEFINITIONS AUTOMATIC TAGS ::=
+BEGIN
+T ::= CHOICE {
+        x REAL,
+        y INTEGER,
+        z OBJECT IDENTIFIER }
+END
+

It is then possible to assign values as follows:

+ 
+TVal1 = {y,17},
+TVal2 = {z,{0,1,2}},
+

A CHOICE value is always represented as the tuple + {ChoiceAlternative, Val} where ChoiceAlternative + is an atom denoting the selected choice alternative. +

+ +
+ Extensible CHOICE +

When a CHOICE contains an extension marker and the + decoder detects an unknown alternative of the CHOICE, + the value is represented as follows:

+ 
+{asn1_ExtAlt, BytesForOpenType}
+

Here BytesForOpenType is a list of bytes constituting the + encoding of the "unknown" CHOICE alternative.

+
+
+ +
+ + SET OF and SEQUENCE OF +

The types SET OF and SEQUENCE OF correspond + to the concept of an array + in several programming languages. The Erlang syntax for + both types is straightforward, for example:

+ 
+Arr1 ::= SET SIZE (5) OF INTEGER (4..9) 
+Arr2 ::= SEQUENCE OF OCTET STRING
+

In Erlang the following can apply:

+ 
+Arr1Val = [4,5,6,7,8],
+Arr2Val = ["abc",[14,34,54],"Octets"],
+

Notice that the definition of type SET OF implies that + the order of the components is undefined, but in practice there is + no difference between SET OF and SEQUENCE OF. + The ASN.1 compiler for Erlang does not randomize the order of the + SET OF components before encoding.

+

However, for a value of type SET OF, the DER + encoding format requires the elements to be sent in ascending + order of their encoding, which implies an expensive sorting + procedure in runtime. Therefore it is recommended to + use SEQUENCE OF instead of SET OF if possible.

+
+ +
+ + ANY and ANY DEFINED BY +

The types ANY and ANY DEFINED BY have been removed + from the standard since 1994. It is recommended not to use + these types any more. They can, however, exist in some old ASN.1 + modules. The idea with this type was to leave a "hole" in a + definition where it was possible to + put unspecified data of any kind, even non-ASN.1 data.

+

A value of this type is encoded as an open type.

+

Instead of ANY and ANY DEFINED BY, it is + recommended to use + information object class, table constraints, and + parameterization. In particular the construct + TYPE-IDENTIFIER.@Type accomplish the same as the + deprecated ANY.

+

See also + Information object.

+
+ +
+ + EXTERNAL, EMBEDDED PDV, and CHARACTER STRING +

The types EXTERNAL, EMBEDDED PDV, and + CHARACTER STRING are used in presentation layer negotiation. + They are encoded according to their associated type, see X.680.

+

The type EXTERNAL had a slightly different associated type + before 1994. X.691 states that encoding must follow + the older associated type. So, generated encode/decode + functions convert values of the newer format to the older format + before encoding. This implies that it is allowed to use + EXTERNAL type values of either format for encoding. Decoded + values are always returned in the newer format.

+
+ +
+ Embedded Named Types +

The structured types previously described can have other named + types as their components. The general syntax to assign a value + to component C of a named ASN.1 type T in Erlang + is the record syntax #'T'{'C'=Value}. + Here Value can be a value of yet another type T2, + for example:

+ 
+EmbeddedExample DEFINITIONS AUTOMATIC TAGS ::=
+BEGIN
+B ::= SEQUENCE {
+        a Arr1,
+        b T }
+
+Arr1 ::= SET SIZE (5) OF INTEGER (4..9) 
+
+T ::= CHOICE {
+        x REAL,
+        y INTEGER,
+        z OBJECT IDENTIFIER }
+        END
+

SEQUENCE b can be encoded as follows in Erlang:

+ 
+1> 'EmbeddedExample':encode('B', {'B',[4,5,6,7,8],{x,"7.77"}}).
+{ok,<<5,56,0,8,3,55,55,55,46,69,45,50>>}
+
+
+ +
+ Naming of Records in .hrl Files +

When an ASN.1 specification is compiled, all defined types of type + SET or SEQUENCE result in a corresponding record in the + generated .hrl file. This is because the values for + SET and SEQUENCE are represented as records as + mentioned earlier.

+

Some special cases of this functionality are presented in the + next section.

+ +
+ Embedded Structured Types +

In ASN.1 it is also possible to have components that are themselves + structured types. + For example, it is possible to have the following:

+ 
+Emb ::= SEQUENCE {
+    a SEQUENCE OF OCTET STRING,
+    b SET {
+       a INTEGER,
+       b INTEGER DEFAULT 66},
+    c CHOICE {
+       a INTEGER,
+       b FooType } }
+
+FooType ::= [3] VisibleString
+

The following records are generated because of type Emb:

+ 
+-record('Emb,{a, b, c}).
+-record('Emb_b',{a, b = asn1_DEFAULT}). % the embedded SET type
+

Values of type Emb can be assigned as follows:

+ +V = #'Emb'{a=["qqqq",[1,2,255]], + b = #'Emb_b'{a=99}, + c ={b,"Can you see this"}}. +

For an embedded type of type SEQUENCE/SET in a + SEQUENCE/SET, the record name is extended with an + underscore and the component name. If the embedded structure is + deeper with the SEQUENCE, SET, or CHOICE + types in the line, each component name/alternative name is + added to the record name.

+

Example:

+ 
+Seq ::= SEQUENCE{
+    a CHOICE{
+        b SEQUENCE {
+           c  INTEGER
+        }
+    }
+}
+

This results in the following record:

+ 
+-record('Seq_a_b',{c}).
+

If the structured type has a component with an embedded + SEQUENCE OF/SET OF which embedded type in turn + is a SEQUENCE/SET, it gives a record with the + SEQUENCE OF/SET OF + addition as in the following example:

+ 
+Seq ::= SEQUENCE {
+    a SEQUENCE OF SEQUENCE {
+           b
+               }
+    c SET OF SEQUENCE {
+           d
+               }
+}
+

This results in the following records:

+ 
+-record('Seq_a_SEQOF'{b}).
+-record('Seq_c_SETOF'{d}).
+

A parameterized type is to be considered as an embedded + type. Each time such a type is referenced, an instance of it is + defined. Thus, in the following example a record with name + 'Seq_b' is generated in the .hrl file and is used + to hold values:

+ 
+Seq ::= SEQUENCE {
+    b PType{INTEGER}
+}
+
+PType{T} ::= SEQUENCE{
+    id T
+}
+
+ +
+ Recursive Types +

Types that refer to themselves are called recursive types. + Example:

+ 
+Rec ::= CHOICE {
+     nothing NULL,
+     something SEQUENCE {
+          a INTEGER,
+          b OCTET STRING,
+          c Rec }}
+

This is allowed in ASN.1 and the ASN.1-to-Erlang compiler + supports this recursive type. + A value for this type is assigned in Erlang as follows:

+ 
+V = {something,#'Rec_something'{a = 77, 
+                                b = "some octets here", 
+                                c = {nothing,'NULL'}}}.
+
+
+ +
+ ASN.1 Values +

Values can be assigned to an ASN.1 type within the ASN.1 code + itself, as opposed to the actions in the previous section where + a value was assigned to an ASN.1 type in Erlang. The full value + syntax of ASN.1 is supported and X.680 describes in detail how + to assign values in ASN.1. A short example:

+ 
+TT ::= SEQUENCE {
+   a INTEGER,
+   b SET OF OCTET STRING }
+
+tt TT ::= {a 77,b {"kalle","kula"}}
+

The value defined here can be used in several ways. It can, for + example, be used as the value in some DEFAULT component:

+ 
+SS ::= SET {
+    s OBJECT IDENTIFIER,
+    val TT DEFAULT tt }
+

It can also be used from inside an Erlang program. If this ASN.1 + code is defined in ASN.1 module Values, the ASN.1 value + tt can be reached from Erlang as a function call to + 'Values':tt() as in the following example:

+ 
+1> Val = 'Values':tt().
+{'TT',77,["kalle","kula"]}
+2> {ok,Bytes} = 'Values':encode('TT',Val).
+{ok,<<48,18,128,1,77,161,13,4,5,107,97,108,108,101,4,4,
+      107,117,108,97>>}
+4> 'Values':decode('TT',Bytes).
+{ok,{'TT',77,["kalle","kula"]}}
+5>
+

This example shows that a function is generated by the compiler + that returns a valid Erlang representation of the value, although + the value is of a complex type.

+

Furthermore, a macro is generated for each value in the .hrl + file. So, the defined value tt can also be extracted by + ?tt in application code.

+
+ +
+ Macros +

The type MACRO is not supported. It is no longer part of + the ASN.1 standard.

+
+ +
+ + ASN.1 Information Objects (X.681) +

Information Object Classes, Information Objects, and Information + Object Sets (in the following called classes, objects, and + object sets, respectively) are defined in the standard + definition X.681. Only a brief explanation is given here.

+

These constructs makes it possible to define open types, that + is, values of that type can be of any ASN.1 type. Also, + relationships can be defined between different types and + values, as classes can hold types, values, objects, object + sets, and other classes in their fields. A class can be + defined in ASN.1 as follows:

+ 
+GENERAL-PROCEDURE ::= CLASS {
+      &Message,
+      &Reply               OPTIONAL,
+      &Error               OPTIONAL,
+      &id          PrintableString UNIQUE
+}
+WITH SYNTAX {
+      NEW MESSAGE     &Message
+      [REPLY           &Reply]
+      [ERROR           &Error]
+      ADDRESS          &id
+}
+

An object is an instance of a class. An object set is a set + containing objects of a specified class. A definition can look + as follows:

+ 
+object1 GENERAL-PROCEDURE ::= {
+    NEW MESSAGE      PrintableString
+    ADDRESS          "home"
+}
+
+object2 GENERAL-PROCEDURE ::= {
+    NEW MESSAGE INTEGER
+    ERROR INTEGER
+    ADDRESS "remote"
+}
+

The object object1 is an instance of the class + GENERAL-PROCEDURE and has one type field and one + fixed type value field. The object object2 has also an + optional field ERROR, which is a type field. The field + ADDRESS is a UNIQUE field. Objects in an object set + must have unique values in their UNIQUE field, as in + GENERAL-PROCEDURES:

+ 
+GENERAL-PROCEDURES GENERAL-PROCEDURE ::= {
+    object1 | object2}
+

You cannot encode a class, object, or object set, only refer to + it when defining other ASN.1 entities. Typically you refer to a + class as well as to object sets by table constraints and component + relation constraints (X.682) in ASN.1 types, as in the following:

+ 
+StartMessage  ::= SEQUENCE {
+    msgId  GENERAL-PROCEDURE.&id  ({GENERAL-PROCEDURES}),
+    content GENERAL-PROCEDURE.&Message ({GENERAL-PROCEDURES}{@msgId}),
+    }
+

In type StartMessage, the constraint following field + content tells that in a value of type + StartMessage the value in field content must + come from the same object that is chosen by field msgId.

+

So, the value + #'StartMessage'{msgId="home",content="Any Printable String"} + is legal to encode as a StartMessage value. However, the value + #'StartMessage'{msgId="remote", content="Some String"} + is illegal as the constraint in StartMessage tells that + when you have chosen a value from a specific object in object + set GENERAL-PROCEDURES in field + msgId, you must choose a value from that same object in + the content field too. In this second case, it is to be + any INTEGER value.

+

StartMessage can in field content be + encoded with a value of any type that an object in object set + GENERAL-PROCEDURES has in its NEW MESSAGE field. + This field refers to a type field + &Message in the class. Field msgId is always + encoded as a PrintableString, as the field refers to a + fixed type in the class.

+

In practice, object sets are usually declared to be extensible so + that more objects can be added to the set later. Extensibility is + indicated as follows:

+ 
+GENERAL-PROCEDURES GENERAL-PROCEDURE ::= {
+    object1 | object2, ...}
+

When decoding a type that uses an extensible set constraint, + it is always possible that the value in field UNIQUE + is unknown (that is, the type has been encoded with a later + version of the ASN.1 specification). The unencoded data is then + returned wrapped in a tuple as follows:

+ + 
+{asn1_OPENTYPE,Binary}
+ +

Here Binary is an Erlang binary that contains the encoded + data. (If option legacy_erlang_types has been given, + only the binary is returned.)

+
+ +
+ Parameterization (X.683) +

Parameterization, which is defined in X.683, can be used when + defining types, values, value sets, classes, objects, or object sets. + A part of a definition can be supplied as a parameter. For + example, if a Type is used in a definition with a certain + purpose, you want the type name to express the intention. This + can be done with parameterization.

+

When many types (or another ASN.1 entity) only differ in some + minor cases, but the structure of the types is similar, only + one general type can be defined and the differences can be supplied + through parameters.

+

Example of use of parameterization:

+ 
+General{Type} ::= SEQUENCE
+{
+     number     INTEGER,
+     string     Type
+}
+      
+T1 ::= General{PrintableString}
+
+T2 ::= General{BIT STRING}
+

An example of a value that can be encoded as type T1 is + {12,"hello"}.

+

Notice that the compiler does not generate encode/decode functions + for parameterized types, only for the instances of the parameterized + types. Therefore, if a file contains the types General{}, + T1, and T2 as in the previous example, encode/decode + functions are only generated for T1 and T2. +

+
+ + diff --git a/lib/asn1/doc/src/asn1_introduction.xml b/lib/asn1/doc/src/asn1_introduction.xml new file mode 100644 index 0000000000..ae0379684a --- /dev/null +++ b/lib/asn1/doc/src/asn1_introduction.xml @@ -0,0 +1,99 @@ + + + + +
+ + 19972013 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + Introduction + + + 2015-03-31 + A + asn1_introduction.xml +
+ +

The ASN.1 application provides the following:

+ + + An ASN.1 compiler for Erlang, which generates encode and + decode functions to be used by Erlang programs sending and + receiving ASN.1 specified data. + Runtime functions used by the generated code. + Support for the following encoding rules: + Basic Encoding Rules (BER) + Distinguished Encoding Rules (DER), a specialized form of + BER that is used in security-conscious applications + Packed Encoding Rules (PER), both the aligned and + unaligned variant + + + + +
+ Scope +

This application covers all features of ASN.1 up to the 1997 + edition of the specification. In the 2002 edition, + new features were introduced. The following features + of the 2002 edition are fully or partly supported:

+ + +

Decimal notation (for example, "1.5e3) for REAL values. + The NR1, NR2, and NR3 formats as explained in ISO 6093 are + supported.

+ + +

The RELATIVE-OID type for relative object identifiers is + fully supported.

+ + +

The subtype constraint (CONTAINING/ENCODED BY) to + constrain the content of an octet string or a bit string is + parsed when compiling, but no further action is taken. This + constraint is not a PER-visible constraint.

+ + +

The subtype constraint by regular expressions (PATTERN) + for character string types is parsed when compiling, but no + further action is taken. This constraint is not a + PER-visible constraint.

+ + +

Multiple-line comments as in C, /* ... */, are + supported.

+ + +
+ +
+ Prerequisites +

It is assumed that the reader is familiar with the Erlang + programming language, concepts of OTP, and is familiar with the + ASN.1 notation. The ASN.1 notation is documented in the standard + definition X.680, which is the primary text. It can also be + helpful, but not necessary, to read the standard definitions + X.681, X.682, X.683, X.690, and X.691.

+

A good book explaining those reference texts is + Dubuisson: ASN.1 - Communication Between Heterogeneous Systems, + is free to download at + http://www.oss.com/asn1/dubuisson.html.

+
+ + + diff --git a/lib/asn1/doc/src/asn1_overview.xml b/lib/asn1/doc/src/asn1_overview.xml new file mode 100644 index 0000000000..4a10819c36 --- /dev/null +++ b/lib/asn1/doc/src/asn1_overview.xml @@ -0,0 +1,49 @@ + + + + +
+ + 19972013 + Ericsson AB. All Rights Reserved. + + + The contents of this file are subject to the Erlang Public License, + Version 1.1, (the "License"); you may not use this file except in + compliance with the License. You should have received a copy of the + Erlang Public License along with this software. If not, it can be + retrieved online at http://www.erlang.org/. + + Software distributed under the License is distributed on an "AS IS" + basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See + the License for the specific language governing rights and limitations + under the License. + + + + ASN.1 + Kenneth Lundin + + 1999-03-25 + D + asn1_overview.xml +
+ +
+ Introduction + +

ASN.1 is a formal language for + describing data structures to be exchanged between distributed + computer systems. The purpose of ASN.1 is to have a platform + and programming language independent notation to express types + using a standardized set of rules for the transformation of + values of a defined type into a stream of bytes. This stream of + bytes can then be sent on any type of communication + channel. This way, two applications written in different + programming languages running on different computers, and with + different internal representation of data, can exchange instances + of structured data types.

+ +
+ + diff --git a/lib/asn1/doc/src/asn1_spec.xmlsrc b/lib/asn1/doc/src/asn1_spec.xmlsrc index 9001aca65c..5bee9f0075 100644 --- a/lib/asn1/doc/src/asn1_spec.xmlsrc +++ b/lib/asn1/doc/src/asn1_spec.xmlsrc @@ -29,94 +29,105 @@ asn1_spec.xml
-

When performance is of highest priority and one is interested in - a limited part of the ASN.1 encoded message, before one decide what - to do with the rest of it, one may want to decode only this small - part. The situation may be a server that has to decide to which - addressee it will send a message. The addressee may be interested in - the entire message, but the server may be a bottleneck that one want - to spare any unnecessary load. Instead of making two complete decodes (the normal case of decode), one in the server and one - in the addressee, it is only necessary to make one specialized decode(in the server) and another complete decode(in the - addressee). The following specialized decodes exclusive decode and selected decode support to solve this and - similar problems. -

+

When performance is of highest priority and you are interested in + a limited part of the ASN.1 encoded message before deciding what + to do with the rest of it, an option is to decode only this small + part. The situation can be a server that has to decide the + addressee of a message. The addressee can be interested in + the entire message, but the server can be a bottleneck that you want + to spare any unnecessary load.

+

Instead of making two complete decodes (the normal case of + decode), one in the server and one in the addressee, it is only + necessary to make one specialized decode(in the server) + and another complete decode(in the addressee). This section + describes the following two specialized decodes, which support + to solve this and similar problems:

+ + Exclusive decode + Selected decode +

So far this functionality is only provided when using the - optimized BER_BIN version, that is when compiling with the - options ber_bin and optimize. It does also work - using the nif option. We have no intent to make this - available on the default BER version, but maybe in the PER_BIN - version (per_bin). + optimized BER_BIN version, that is, when compiling with + options ber_bin and optimize. It also works + with optionnif. We do not intent to make this functionality + available in the default BER version, but possibly in the + PER_BIN version (per_bin).

Exclusive Decode

The basic idea with exclusive - decode is that you specify which parts of the message you want to + decode is to specify which parts of the message you want to exclude from being decoded. These parts remain encoded and are - returned in the value structure as binaries. They may be decoded + returned in the value structure as binaries. They can be decoded in turn by passing them to a certain decode_part/2 - function. The performance gain is high when the message is large - and you can do an exclusive decode and later on one or several - decodes of the parts or a second complete decode instead of two or + function. The performance gain is high for large messages. + You can do an exclusive decode and later one or more + decodes of the parts, or a second complete decode instead of two or more complete decodes.

- How To Make It Work -

In order to make exclusive decode work you have to do the - following: + Procedure +

To perform an exclusive decode:

- First,decide the name of the function for the exclusive - decode. - Second, write instructions that must consist of the name - of the exclusive decode function, the name of the ASN.1 - specification and a notation that tells which parts of the - message structure will be excluded from decode. These - instructions shall be included in a configuration - file. - Third, compile with the additional option - asn1config. The compiler searches for a configuration - file with the same name as the ASN.1 spec but with the - extension .asn1config. This configuration file is not the same - as used for compilation of a set of files. See section - Writing an Exclusive Decode Instruction. + Step 1: Decide the name of the function for the + exclusive decode. +

Step 2: Include the following instructions in + a configuration file:

+ + The name of the exclusive decode function + The name of the ASN.1 specification + A notation that tells which parts of the message + structure to be excluded from decode + + Step 3 Compile with the additional option + asn1config. The compiler searches for a configuration + file with the same name as the ASN.1 specification but with + extension .asn1config. This configuration file is not + the same as used for compilation of a set of files. See Section + Writing an Exclusive Decode + Instruction.
User Interface -

The run-time user interface for exclusive decode consists of - two different functions. First, the function for an exclusive - decode, whose name the user decides in the configuration - file. Second, the compiler generates a decode_part/2 - function when exclusive decode is chosen. This function decodes - the parts that were left undecoded during the exclusive - decode. Both functions are described below. -

-

If the exclusive decode function has for example got the name +

The runtime user interface for exclusive decode consists of + the following two functions:

+ + A function for an exclusive decode, whose name the user + decides in the configuration file + The compiler generates a decode_part/2 + function when exclusive decode is chosen. This function decodes + the parts that were left undecoded during the exclusive + decode. + +

Both functions are described in the following.

+

If the exclusive decode function has, for example, the name decode_exclusive and an ASN.1 encoded message - Bin shall be exclusive decoded, the call is:

+ Bin is to be exclusive decoded, the call is as follows:

 {ok,Excl_Message} = 'MyModule':decode_exclusive(Bin)
-

The result Excl_Message has the same structure as an - complete decode would have, except for the parts of the top-type - that were not decoded. The undecoded parts will be on their place - in the structure on the format {Type_Key,Undecoded_Value}. +

The result Excl_Message has the same structure as a + complete decode would have, except for the parts of the top type + that were not decoded. The undecoded parts are on their places + in the structure on format {Type_Key,Undecoded_Value}.

-

Each undecoded part that shall be decoded must be fed into the decode_part/2 function,like:

+

Each undecoded part that is to be decoded must be fed into + function decode_part/2 as follows:

-{ok,Part_Message} = 'MyModule':decode_part(Type_Key,Undecoded_Value)
+{ok,Part_Message} = 'MyModule':decode_part(Type_Key,Undecoded_Value)
Writing an Exclusive Decode Instruction -

This instruction is written in the configuration file on the - format:

+

This instruction is written in the configuration file + in the following format:

-
 Exclusive_Decode_Instruction = {exclusive_decode,{Module_Name,Decode_Instructions}}.
 
 Module_Name = atom()
@@ -137,70 +148,76 @@ Element = {Name,parts} |
 
 Top_Type = atom()
 
-Name = atom()
-
-

Observe that the instruction must be a valid Erlang term ended - by a dot. +Name = atom() +

The instruction must be a valid Erlang term ended by a dot.

-

In the Type_List the "path" from the top type to each - undecoded sub-components is described. The top type of the path is +

In Type_List the "path" from the top type to each + undecoded subcomponents is described. The top type of the path is an atom, the name of it. The action on each component/type that - follows will be described by one of {Name,parts}, {Name,undecoded}, {Name,Element_List}

-

The use and effect of the actions are: + follows is described by one of + {Name,parts}, {Name,undecoded}, {Name,Element_List}.

+

The use and effect of the actions are as follows:

- {Name,undecoded} Tells that the element will be - left undecoded during the exclusive decode. The type of Name may - be any ASN.1 type. The value of element Name will be returned as a - tuple,as mentioned above, in the value structure of the top type. - {Name,parts} The type of Name may be one of - SEQUENCE OF or SET OF. The action implies that the different - components of Name will be left undecoded. The value of Name - will be returned as a tuple, as above , where the second element is a list of - binaries. That is because the representation of a SEQUENCE OF/ - SET OF in Erlang is a list of its internal type. Any of the - elements of this list or the entire list can be decoded by the - decode_part function. - {Name,Element_List}This action is used when one or - more of the sub-types of Name will be exclusive decoded. + {Name,undecoded} - Tells that the element is left + undecoded during the exclusive decode. The type of Name + can be any ASN.1 type. The value of element Name is + returned as a tuple (as mentioned in the previous section) in + the value structure of the top type. + {Name,parts} - The type of Name can be one of + SEQUENCE OF or SET OF. The action implies that + the different components of Name are left undecoded. The + value of Name is returned as a tuple (as mentioned in + the previous section) where the second element is a list of + binaries. This is because the representation of a SEQUENCE OF + or a SET OF in Erlang is a list of its internal type. Any + of the elements in this list or the entire list can be decoded by + function decode_part. + {Name,Element_List} - This action is used when one or + more of the subtypes of Name is exclusive decoded. -

Name in the actions above may be a component name of a - SEQUENCE or a SET or a name of an alternative in a CHOICE. +

Name in these actions can be a component name of a + SEQUENCE OF or a SET OF, or a name of an alternative + in a CHOICE.

Example -

In the examples below we use the definitions from the following ASN.1 spec:

+

In this examples, the definitions from the following ASN.1 + specification are used:

-

If Button is a top type and we want to exclude - component number from decode the Type_List in the - instruction in the configuration file will be - ['Button',[{number,undecoded}]]. If we call the decode - function decode_Button_exclusive the Decode_Instruction - will be +

If Button is a top type and it is needed to exclude + component number from decode, Type_List in the + instruction in the configuration file is + ['Button',[{number,undecoded}]]. If you call the decode + function decode_Button_exclusive, Decode_Instruction is {decode_Button_exclusive,['Button',[{number,undecoded}]]}.

-

We also have another top type Window whose sub - component actions in type Status and the parts of component - buttonList shall be left undecoded. For this type we name - the function decode__Window_exclusive. The whole - Exclusive_Decode_Instruction configuration is as follows:

+

Another top type is Window whose subcomponent + actions in type Status and the parts of component + buttonList are to be left undecoded. For this type, the + function is named decode__Window_exclusive. The complete + Exclusive_Decode_Instruction configuration is as follows:

+

The following figure shows the bytes of a Window:status + message. The components buttonList and actions are + excluded from decode. Only state and enabled are decoded + when decode__Window_exclusive is called.

- Figure symbolizes the bytes of a Window:status message. The components buttonList and actions are excluded from decode. Only state and enabled are decoded when decode__Window_exclusive is called. + Bytes of a Window:status Message

-

Compiling GUI.asn including the configuration file is done like:

+

Compiling GUI.asn including the configuration file is done + as follows:

 unix> erlc -bber_bin +optimize +asn1config GUI.asn
 
-erlang> asn1ct:compile('GUI',[ber_bin,optimize,asn1config]).
-

The module can be used like:

+erlang> asn1ct:compile('GUI',[ber_bin,optimize,asn1config]). +

The module can be used as follows:

-
 1> Button_Msg = {'Button',123,true}.
 {'Button',123,true}
 2> {ok,Button_Bytes} = 'GUI':encode('Button',Button_Msg).
@@ -289,35 +306,39 @@ BoolOpt,{Type_Key_Choice,Val_Choice}}}}=
 11> 'GUI':decode_part(Type_Key_SeqOf,hd(Val_SEQOF)).
 {ok,{'Button',3,true}}
 12> 'GUI':decode_part(Type_Key_Choice,Val_Choice).  
-{ok,{possibleActions,[{'Action',16,{'Button',17,true}}]}}
-
+{ok,{possibleActions,[{'Action',16,{'Button',17,true}}]}}
Selective Decode -

This specialized decode decodes one single subtype of a - constructed value. It is the fastest method to extract one sub - value. The typical use of this decode is when one want to - inspect, for instance a version number,to be able to decide what +

This specialized decode decodes a subtype of a + constructed value and is the fastest method to extract a + subvalue. This decode is typically used when you want to + inspect, for example, a version number, to be able to decide what to do with the entire value. The result is returned as {ok,Value} or {error,Reason}.

- How To Make It Work -

The following steps are necessary: + Procedure +

To perform a selective decode:

- Write instructions in the configuration - file. Including the name of a user function, the name of the ASN.1 - specification and a notation that tells which part of the type - will be decoded. - Compile with the additional option - asn1config. The compiler searches for a configuration file - with the same name as the ASN.1 spec but with the extension - .asn1config. In the same file you can provide configuration specs - for exclusive decode as well. The generated Erlang module has the +

Step 1: Include the following instructions in + the configuration file:

+ + The name of the user function + The name of the ASN.1 specification + A notation that tells which part of the type to be + decoded + + Step 2: Compile with the additional option + asn1config. The compiler searches for a configuration file + with the same name as the ASN.1 specification, but with extension + .asn1config. In the same file you can also provide + configuration specifications for exclusive decode. + The generated Erlang module has the usual functionality for encode/decode preserved and the specialized decode functionality added. @@ -326,21 +347,20 @@ BoolOpt,{Type_Key_Choice,Val_Choice}}}}=
User Interface

The only new user interface function is the one provided by the - user in the configuration file. You can invoke that function by + user in the configuration file. The function is started by the ModuleName:FunctionName notation.

-

So, if you have the following spec +

For example, if the configuration file includes the specification {selective_decode,{'ModuleName',[{selected_decode_Window,TypeList}]}} - in the con-fig file, you do the selective decode by + do the selective decode by {ok,Result}='ModuleName':selected_decode_Window(EncodedBinary).

Writing a Selective Decode Instruction -

It is possible to describe one or many selective decode - functions in a configuration file, you have to use the following - notation:

+

One or more selective decode functions can be described in a + configuration file. Use the following notation:

 Selective_Decode_Instruction = {selective_decode,{Module_Name,Decode_Instructions}}.
 
@@ -358,37 +378,43 @@ Element_List = Name|List_Selector
 
 Name = atom()
 
-List_Selector = [integer()]
-

Observe that the instruction must be a valid Erlang term ended - by a dot. -

-

The Module_Name is the same as the name of the ASN.1 - spec, but without the extension. A Decode_Instruction is - a tuple with your chosen function name and the components from - the top type that leads to the single type you want to - decode. Notice that you have to choose a name of your function - that will not be the same as any of the generated functions. The - first element of the Type_List is the top type of the - encoded message. In the Element_List it is followed by - each of the component names that leads to selected type. Each of - the names in the Element_List must be constructed types - except the last name, which can be any type. +List_Selector = [integer()] +

The instruction must be a valid Erlang term ended by a dot.

-

The List_Selector makes it possible to choose one of the - encoded components in a SEQUENCE OF/ SET OF. It is also possible - to go further in that component and pick a sub type of that to - decode. So in the Type_List: ['Window',status,buttonList,[1],number] the - component buttonList has to be a SEQUENCE OF or SET OF type. In - this example component number of the first of the encoded - elements in the SEQUENCE OF buttonList is selected. This apply on - the ASN.1 spec above. + + Module_Name is the same as the name of the ASN.1 + specification, but without the extension. + Decode_Instruction is a tuple with your chosen + function name and the components from the top type that leads + to the single type you want to decode. Ensure to choose a name + of your function that is not the same as any of the generated + functions. + The first element of Type_List is the top type of the + encoded message. In Element_List, it is followed by + each of the component names that leads to selected type. + Each name in Element_List must be a constructed type + except the last name, which can be any type. + List_Selector makes it possible to choose one of the + encoded components in a a SEQUENCE OF or a SET OF. + It is also possible to go further in that component and pick a + subtype of that to decode. So, in the Type_List: + ['Window',status,buttonList,[1],number], component + buttonList must be of type SEQUENCE OF or + SET OF. + +

In the example, component number of the first of the encoded + elements in the SEQUENCE OF buttonList is selected. + This applies on the ASN.1 specification in Section + Writing an Exclusive Decode + Instruction.

Another Example -

In this example we use the same ASN.1 spec as above. A valid selective decode - instruction is:

+

In this example, the same ASN.1 specification as in Section + Writing an Exclusive Decode Instruction + is used. The following is a valid selective decode instruction:

 {selective_decode,
     {'GUI',
@@ -404,16 +430,17 @@ List_Selector = [integer()]
actions, possibleActions, [1], - handle,number]}]}}. - -

The first Decode_Instruction, + handle,number]}]}}. +

The first instruction, {selected_decode_Window1,['Window',status,buttonList,[1],number]} - is commented in the previous section. The instruction - {selected_decode_Action,['Action',handle,number]} picks - the component number in the handle component of the type - Action. If we have the value ValAction = {'Action',17,{'Button',4711,false}} the internal value 4711 - should be picked by selected_decode_Action. In an Erlang - terminal it looks like:

+ is described in the previous section.

+

The second instruction, + {selected_decode_Action,['Action',handle,number]}, takes + component number in the handle component of type + Action. If the value is + ValAction = {'Action',17,{'Button',4711,false}}, the internal + value 4711 is to be picked by selected_decode_Action. In an + Erlang terminal it looks as follows:

 ValAction = {'Action',17,{'Button',4711,false}}.
 {'Action',17,{'Button',4711,false}}
@@ -423,44 +450,41 @@ ValAction = {'Action',17,{'Button',4711,false}}.
 <<48,18,2,1,17,160,13,172,11,171,9,48,7,128,2,18,103,129,1,0>>
 9> 'GUI':selected_decode_Action(BinBytes).
 {ok,4711}
-10>
+10>

The third instruction, ['Window',status,actions,possibleActions,[1],handle,number], - which is a little more complicated,

+ works as follows:

- starts with type Window. - Picks component status of Window that is - of type Status. - Then takes component actions of type + Step 1: Starts with type Window. + Step 2: Takes component status of Window + that is of type Status. + Step 3: Takes actions of type Status. - Then possibleActions of the internal defined - CHOICE type. - Thereafter it goes into the first component of the - SEQUENCE OF by [1]. That component is of type - Action. - The instruction next picks component - handle. - And finally component number of the type + Step 4: Takes possibleActions of the internally + defined CHOICE type. + Step 5: Goes into the first component of + SEQUENCE OF by [1]. That component is of type + Action. + Step 6: Takes component handle. + Step 7: Takes component number of type Button. -

The following figures shows which components are in the - TypeList - ['Window',status,actions,possibleActions,[1],handle,number]. And - which part of a message that will be decoded by - selected_decode_Window2. -

+

The following figure shows which components are in TypeList + ['Window',status,actions,possibleActions,[1],handle,number]:

- The elements specified in the config file for selective decode of a sub-value in a Window message + Elements Specified in Configuration File for Selective Decode of a Subvalue in a Window Message +

In the following figure, only the marked element is decoded by + selected_decode_Window2:

- Figure symbolizes the bytes of a Window:status message. Only the marked element is decoded when selected_decode_Window2 is called. + Bytes of a Window:status Message -

With the following example you can examine that both +

With the following example, you can examine that both selected_decode_Window2 and - selected_decode_Window1 decodes the intended sub-value - of the value Val

+ selected_decode_Window1 decodes the intended subvalue + of value Val:

 1> Val = {'Window',{status,{'Status',12,
                     [{'Button',13,true},
@@ -478,8 +502,8 @@ ValAction = {'Action',17,{'Button',4711,false}}.
 4> 'GUI':selected_decode_Window1(Bin).
 {ok,13}
 5> 'GUI':selected_decode_Window2(Bin).
-{ok,18}
-

Observe that the value feed into the selective decode +{ok,18} +

Notice that the value fed into the selective decode functions must be a binary.

@@ -489,19 +513,19 @@ ValAction = {'Action',17,{'Button',4711,false}}. Performance

To give an indication on the possible performance gain using the specialized decodes, some measures have been performed. The - relative figures in the outcome between selective, exclusive and - complete decode (the normal case) depends on the structure of - the type, the size of the message and on what level the + relative figures in the outcome between selective, exclusive, and + complete decode (the normal case) depend on the structure of + the type, the size of the message, and on what level the selective and exclusive decodes are specified.

- ASN.1 Specifications, Messages and Configuration -

The specs GUI and + ASN.1 Specifications, Messages, and Configuration +

The specifications GUI and MEDIA-GATEWAY-CONTROL - was used in the test. + were used in the test.

-

For the GUI spec the configuration looked like:

+

For the GUI specification the configuration was as follows:

 {selective_decode,
   {'GUI',
@@ -523,9 +547,8 @@ ValAction = {'Action',17,{'Button',4711,false}}.
                 ['Window',
                  [{status,
                      [{buttonList,parts},
-                      {actions,undecoded}]}]]}]}}.
-
-

The MEDIA-GATEWAY-CONTROL configuration was:

+ {actions,undecoded}]}]]}]}}. +

The MEDIA-GATEWAY-CONTROL configuration was as follows:

 {exclusive_decode,
   {'MEDIA-GATEWAY-CONTROL',
@@ -538,9 +561,8 @@ ValAction = {'Action',17,{'Button',4711,false}}.
 {selective_decode,
   {'MEDIA-GATEWAY-CONTROL',
     [{decode_MegacoMessage_selective,
-         ['MegacoMessage',mess,version]}]}}.
-
-

The corresponding values were:

+ ['MegacoMessage',mess,version]}]}}. +

The corresponding values were as follows:

 {'Window',{status,{'Status',12,
               [{'Button',13,true},
@@ -649,177 +671,178 @@ ValAction = {'Action',17,{'Button',4711,false}}.
                 {'StatisticsParameter',[0,11,0,3],[[52,53,49,48,48]]},
                 {'StatisticsParameter',[0,12,0,6],[[48,46,50]]},
                 {'StatisticsParameter',[0,12,0,7],[[50,48]]},
-                {'StatisticsParameter',[0,12,0,8],[[52,48]]}]}]}}}]}]}}}]}}}      
-
-

The size of the encoded values was 458 bytes for GUI and 464 - bytes for MEDIA-GATEWAY-CONTROL. + {'StatisticsParameter',[0,12,0,8],[[52,48]]}]}]}}}]}]}}}]}}} +

The size of the encoded values was 458 bytes for GUI and 464 + bytes for MEDIA-GATEWAY-CONTROL.

Results -

The ASN.1 specs in the test are compiled with the options - ber_bin, optimize, driver and asn1config. If the - driver option had been omitted there should have been +

The ASN.1 specifications in the test were compiled with options + ber_bin, optimize, driver and asn1config. Omitting + option driver gives higher values for decode and decode_part. These tests have - not been re-run using nifs, but are expected to perform about 5% better + not been rerun using NIFs, but are expected to perform about 5% better than the linked-in driver.

The test program runs 10000 decodes on the value, resulting - in a printout with the elapsed time in microseconds for the + in an output with the elapsed time in microseconds for the total number of decodes.

Function - Time(microseconds) - Kind of Decode - ASN.1 spec - % of time vs. complete decode + Time (microseconds) + Decode Type + ASN.1 Specification + % of Time versus Complete Decode decode_MegacoMessage_selective/1 374045 - selective + Selective MEDIA-GATEWAY-CONTROL 8.3 decode_MegacoMessage_exclusive/1 621107 - exclusive + Exclusive MEDIA-GATEWAY-CONTROL 13.8 decode/2 4507457 - complete + Complete MEDIA-GATEWAY-CONTROL 100 selected_decode_Window1/1 449585 - selective + Selective GUI 7.6 selected_decode_Window2/1 890666 - selective + Selective GUI 15.1 decode_Window_status_exclusive/1 1251878 - exclusive + Exclusive GUI 21.3 decode/2 5889197 - complete + Complete GUI 100 - Results of complete, exclusive and selective decode + Results of Complete, Exclusive, and Selective Decode
-

Another interesting question is what the relation is between +

It is also of interest to know the relation is between a complete decode, an exclusive decode followed by - decode_part of the excluded parts and a selective decode - followed by a complete decode. Some situations may be compared to - this simulation, e.g. inspect a sub-value and later on look at + decode_part of the excluded parts, and a selective decode + followed by a complete decode. Some situations can be compared to + this simulation, for example, inspect a subvalue and later inspect the entire value. The following table shows figures from this - test. The number of loops and time unit is the same as in the + test. The number of loops and the time unit are the same as in the previous test.

Actions Function     - Time(microseconds) - ASN.1 spec - % of time vs. complete decode + Time (microseconds) + ASN.1 Specification + % of Time vs. Complete Decode - complete + Complete decode/2 4507457 MEDIA-GATEWAY-CONTROL 100 - selective and complete + Selective and Complete decode_­MegacoMessage_­selective/1 4881502 MEDIA-GATEWAY-CONTROL 108.3 - exclusive and decode_part + Exclusive and decode_part decode_­MegacoMessage_­exclusive/1 5481034 MEDIA-GATEWAY-CONTROL 112.3 - complete + Complete decode/2 5889197 GUI 100 - selective and complete + Selective and Complete selected_­decode_­Window1/1 6337636 GUI 107.6 - selective and complete + Selective and Complete selected_­decode_­Window2/1 6795319 GUI 115.4 - exclusive and decode_part + Exclusive and decode_part decode_­Window_­status_­exclusive/1 6249200 GUI 106.1 - Results of complete, exclusive + decode_part and selective + complete decodes + Results of Complete, Exclusive + decode_part, and Selective + complete decodes

Other ASN.1 types and values can differ much from these - figures. Therefore it is important that you, in every case where + figures. It is therefore important that you, in every case where you intend to use either of these decodes, perform some tests - that shows if you will benefit your purpose. + that show if you will benefit your purpose.

- Comments -

Generally speaking the gain of selective and exclusive decode - in advance of complete decode is greater the bigger value and the - less deep in the structure you have to decode. One should also - prefer selective decode instead of exclusive decode if you are - interested in just one single sub-value.

-

Another observation is that the exclusive decode followed by - decode_part decodes is very attractive if the parts will be sent - to different servers for decoding or if one in some cases not is - interested in all parts.

-

The fastest selective decode are when the decoded type is a + Final Remarks + + The gain of using selective and exclusive decode instead of a + complete decode is greater the bigger the value and the + less deep in the structure you have to decode. + Use selective decode instead of exclusive decode if you are + interested in only a single subvalue. + Exclusive decode followed by + decode_part decodes is attractive if the parts are sent + to different servers for decoding, or if you in some cases are not + interested in all parts. + The fastest selective decode is when the decoded type is a primitive type and not so deep in the structure of the top - type. The selected_decode_Window2 decodes a big constructed - value, which explains why this operation is relatively slow.

-

It may vary from case to case which combination of - selective/complete decode or exclusive/part decode is the fastest.

+ type. selected_decode_Window2 decodes a high constructed + value, which explains why this operation is relatively slow. + It can vary from case to case which combination of + selective/complete decode or exclusive/part decode is the fastest. +
diff --git a/lib/asn1/doc/src/asn1_ug.xml b/lib/asn1/doc/src/asn1_ug.xml deleted file mode 100644 index 8b33497dd3..0000000000 --- a/lib/asn1/doc/src/asn1_ug.xml +++ /dev/null @@ -1,1417 +0,0 @@ - - - - -
- - 19972013 - Ericsson AB. All Rights Reserved. - - - The contents of this file are subject to the Erlang Public License, - Version 1.1, (the "License"); you may not use this file except in - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. - - - - Asn1 - Kenneth Lundin - - 1999-03-25 - D - asn1_ug.xml -
- -
- Introduction - -
- Features -

The Asn1 application provides:

- - An ASN.1 compiler for Erlang, which generates encode and - decode functions to be used by Erlang programs sending and - receiving ASN.1 specified data. - Run-time functions used by the generated code. - Support for the following encoding rules: - - - Basic Encoding Rules (BER) - - - Distinguished Encoding Rules (DER), a specialized - form of BER that is used in security-conscious - applications. - - - Packed Encoding Rules (PER); both the aligned and - unaligned variant. - - - - -
- -
- Overview -

ASN.1 (Abstract Syntax Notation One) is a formal language for - describing data structures to be exchanged between distributed - computer systems. The purpose of ASN.1 is to have a platform - and programming language independent notation to express types - using a standardized set of rules for the transformation of - values of a defined type into a stream of bytes. This stream of - bytes can then be sent on any type of communication - channel. This way, two applications written in different - programming languages running on different computers with - different internal representation of data can exchange instances - of structured data types.

-
- -
- Prerequisites -

It is assumed that the reader is familiar with the ASN.1 - notation as documented in the standard definition [] which is the primary text. It may also be - helpful, but not necessary, to read the standard definitions - [] [] [] [] [].

-

A good book explaining those reference texts is - [], which is free to download at - http://www.oss.com/asn1/dubuisson.html. -

-
- -
- Capabilities -

This application covers all features of ASN.1 up to the 1997 - edition of the specification. In the 2002 edition of ASN.1 a - number of new features were introduced. The following features - of the 2002 edition are fully or partly supported as shown - below:

- - -

Decimal notation (e.g., "1.5e3") for REAL values. The - NR1, NR2 and NR3 formats as explained in ISO6093 are - supported.

- - -

The RELATIVE-OID type for relative object identifiers is - fully supported.

- - -

The subtype constraint (CONTAINING/ENCODED BY) to - constrain the content of an octet string or a bit string is - parsed when compiling, but no further action is taken. This - constraint is not a PER-visible constraint.

- - -

The subtype constraint by regular expressions (PATTERN) - for character string types is parsed when compiling, but no - further action is taken. This constraint is not a - PER-visible constraint.

- - -

Multiple-line comments as in C, /* ... */, are - supported.

- - -
- -
- -
- Getting Started with Asn1 - -
- A First Example -

The following example demonstrates the basic functionality used to run - the Erlang ASN.1 compiler.

-

Create a file called People.asn containing the following:

- 
-People DEFINITIONS AUTOMATIC TAGS ::=
-BEGIN
-  Person ::= SEQUENCE {
-    name PrintableString,
-    location INTEGER {home(0),field(1),roving(2)},
-    age INTEGER OPTIONAL
-  }
-END
-

This file (People.asn) must be compiled before it can be - used. - The ASN.1 compiler checks that the syntax is correct and that the - text represents proper ASN.1 code before generating an abstract - syntax tree. The code-generator then uses the abstract syntax - tree in order to generate code. -

-

The generated Erlang files will be placed in the current directory or - in the directory specified with the {outdir,Dir} option. - The following shows how the compiler - can be called from the Erlang shell:

- 
-1> asn1ct:compile("People", [ber]).
-ok
-2>
- -

The verbose option can be given to have information - about the generated files printed:

- 
-2> asn1ct:compile("People", [ber,verbose]).
-Erlang ASN.1 compiling "People.asn" 
---{generated,"People.asn1db"}--
---{generated,"People.hrl"}--
---{generated,"People.erl"}--
-ok
-3>
- -

The ASN.1 module People is now accepted and the - abstract syntax tree is saved in the People.asn1db file; - the generated Erlang code is compiled using the Erlang compiler - and loaded into the Erlang run-time system. Now there is an API - for encode/2 and decode/2 in the module - People, which is invoked by:

- , )]]> -

- or

-, )]]>

- -

Assume there is a network - application which receives instances of the ASN.1 defined - type Person, modifies and sends them back again:

- -receive - {Port,{data,Bytes}} -> - case 'People':decode('Person',Bytes) of - {ok,P} -> - {ok,Answer} = 'People':encode('Person',mk_answer(P)), - Port ! {self(),{command,Answer}}; - {error,Reason} -> - exit({error,Reason}) - end - end, -

In the example above, a series of bytes is received from an - external source and the bytes are then decoded into a valid - Erlang term. This was achieved with the call - 'People':decode('Person',Bytes) which returned - an Erlang value of the ASN.1 type Person. Then an answer was - constructed and encoded using - 'People':encode('Person',Answer) which takes an - instance of a defined ASN.1 type and transforms it to a - binary according to the BER or PER encoding rules. -

-The encoder and the decoder can also be run from - the shell.

- 
-2> Rockstar = {'Person',"Some Name",roving,50}.
-{'Person',"Some Name",roving,50}
-3> {ok,Bin} = 'People':encode('Person',Rockstar).
-{ok,<<243,17,19,9,83,111,109,101,32,78,97,109,101,2,1,2,
-      2,1,50>>}
-4> {ok,Person} = 'People':decode('Person',Bin).
-{ok,{'Person',"Some Name",roving,50}}
-5>
-
- -
- Module dependencies -

It is common that ASN.1 modules import defined types, values and - other entities from another ASN.1 module.

-

Earlier versions of the ASN.1 compiler required that modules that - were imported from had to be compiled before the module that - imported. This caused problems when ASN.1 modules had circular - dependencies.

-

Referenced modules are now parsed when the compiler finds an - entity that is imported. There will not be any code generated for - the referenced module. However, the compiled module rely on - that the referenced modules also will be compiled.

-
-
- -
- The Asn1 Application User Interface -

The Asn1 application provides two separate user interfaces:

- - -

The module asn1ct which provides the compile-time functions - (including the compiler).

- - -

The module asn1rt_nif which provides the run-time functions - for the ASN.1 decoder for the BER back-end.

- - -

The reason for the division of the interface into compile-time - and run-time - is that only run-time modules (asn1rt*) need to be loaded in - an embedded system. -

- -
- Compile-time Functions -

The ASN.1 compiler can be invoked directly from the command-line - by means of the erlc program. This is convenient when compiling - many ASN.1 files from the command-line or when using Makefiles. - Here are some examples of how the erlc command can be used to invoke the - ASN.1 compiler:

- 
-erlc Person.asn
-erlc -bper Person.asn
-erlc -bber ../Example.asn
-erlc -o ../asnfiles -I ../asnfiles -I /usr/local/standards/asn1 Person.asn
-

The useful options for the ASN.1 compiler are:

- - -b[ber | per | uper] - -

Choice of encoding rules, if omitted ber is the - default.

- - -o OutDirectory - -

Where to put the generated files, default is the current - directory.

- - -I IncludeDir - -

Where to search for .asn1db files and ASN.1 - source specs in order to resolve references to other - modules. This option can be repeated many times if there - are several places to search in. The compiler will always - search the current directory first.

- - +der - -

DER encoding rule. Only when using -ber option.

- - +asn1config - -

This functionality works together with the - ber option. It enables the - specialized decodes, see the Specialized Decode chapter. -

- - +undec_rest - -

A buffer that holds a message being decoded may also have - trailing bytes. If those trailing bytes are important they - can be returned along with the decoded value by compiling - the ASN.1 specification with the +undec_rest option. - The return value from the decoder will be - {ok,Value,Rest} where Rest is a binary - containing the trailing bytes.

- - +'Any Erlc Option' - -

You may add any option to the Erlang compiler when - compiling the generated Erlang files. Any option - unrecognized by the ASN.1 compiler will be passed to the - Erlang compiler.

- - -

For a complete description of erlc see Erts Reference Manual.

-

The compiler and other compile-time functions can also be invoked from - the Erlang shell. Below follows a brief - description of the primary functions, for a - complete description of each function see - the Asn1 Reference Manual, the - asn1ct module.

-

The compiler is invoked by using asn1ct:compile/1 with - default options, or asn1ct:compile/2 if explicit options - are given. - Example:

- 
-asn1ct:compile("H323-MESSAGES.asn1").
-

which equals:

- 
-asn1ct:compile("H323-MESSAGES.asn1",[ber]).
-

If one wants PER encoding:

- 
-asn1ct:compile("H323-MESSAGES.asn1",[per]).
-

The generic encode and decode functions can be invoked like this:

- 
-'H323-MESSAGES':encode('SomeChoiceType',{call,"octetstring"}).
-'H323-MESSAGES':decode('SomeChoiceType',Bytes).
-
- -
- Run-time Functions -

When an ASN.1 specification is compiled with the ber - option, the module asn1rt_nif module and the NIF library in - asn1/priv_dir will be needed at run-time.

-

By invoking the function info/0 in a generated module, one - gets information about which compiler options were used.

-
- -
- Errors -

Errors detected at - compile time appear on the screen together with - a line number indicating where in the source file the error - was detected. If no errors are found, an Erlang ASN.1 module will - be created.

-

The run-time encoders and decoders execute within a catch and - returns {ok, Data} or - {error, {asn1, Description}} where - Description is - an Erlang term describing the error.

-
-
- -
- - Multi-file Compilation -

There are various reasons for using multi-file compilation:

- - You want to choose the name for the generated module, - perhaps because you need to compile the same specs for - different encoding rules. - You want only one resulting module. - -

You need to specify which ASN.1 specs you will - compile in a module that must have the extension - .set.asn. You chose name of the module and provide the - names of the ASN.1 specs. For instance, if you have the specs - File1.asn, File2.asn and File3.asn your - module MyModule.set.asn will look like:

- 
-File1.asn
-File2.asn
-File3.asn
-

If you compile with:

- -~> erlc MyModule.set.asn -

the result will be one merged module MyModule.erl with - the generated code from the three ASN.1 specs. -

-
- -
- A quick note about tags - -

Tags used to be important for all users of ASN.1, because it - was necessary to manually add tags to certain constructs in order - for the ASN.1 specification to be valid. Here is an example of - an old-style specification:

- - 
-Tags DEFINITIONS ::=
-BEGIN
-  Afters ::= CHOICE { cheese [0] IA5String,
-                      dessert [1] IA5String }
-END
- -

Without the tags (the numbers in square brackets) the ASN.1 - compiler would refuse to compile the file.

- -

In 1994 the global tagging mode AUTOMATIC TAGS was introduced. - By putting AUTOMATIC TAGS in the module header, the ASN.1 compiler - will automatically add tags when needed. Here is the same - specification in AUTOMATIC TAGS mode:

- - 
-Tags DEFINITIONS AUTOMATIC TAGS ::=
-BEGIN
-  Afters ::= CHOICE { cheese IA5String,
-                      dessert IA5String }
-END
-
- -

Tags will not be mentioned any more in this manual.

-
- -
- - The ASN.1 Types -

This section describes the ASN.1 types including their - functionality, purpose and how values are assigned in Erlang. -

-

ASN.1 has both primitive and constructed types:

-

- - - Primitive types - Constructed types - - - BOOLEAN - SEQUENCE - - - INTEGER - SET - - - REAL - CHOICE - - - NULL - SET OF and SEQUENCE OF - - - ENUMERATED - ANY - - - BIT STRING - ANY DEFINED BY - - - OCTET STRING - EXTERNAL - - - Character Strings - EMBEDDED PDV - - - OBJECT IDENTIFIER - CHARACTER STRING - - - Object Descriptor - - - - The TIME types - - - The supported ASN.1 types -
- - -

Values of each ASN.1 type has its own representation in Erlang - described in the following subsections. Users shall provide - these values for encoding according to the representation, as - in the example below.

- - 
-Operational ::= BOOLEAN --ASN.1 definition
-

In Erlang code it may look like:

- 
-Val = true,
-{ok,Bytes} = MyModule:encode('Operational', Val),
-

Below follows a description of how - values of each type can be represented in Erlang. -

- -
- - BOOLEAN -

Booleans in ASN.1 express values that can be either - TRUE or FALSE. - The meanings assigned to TRUE or FALSE is beyond the scope - of this text.

- - In ASN.1 it is possible to have:

- 
-Operational ::= BOOLEAN
-
-

Assigning a value to the type Operational in Erlang is possible by - using the following Erlang code:

- -Myvar1 = true, - -

Thus, in Erlang the atoms true and false are used - to encode a boolean value.

-
- -
- - INTEGER -

ASN.1 itself specifies indefinitely large integers, and the Erlang - systems with versions 4.3 and higher, support very large - integers, in practice indefinitely large integers.

-

The concept of sub-typing can be applied to integers as well - as to other ASN.1 types. The details of sub-typing are not - explained here, for further info see []. A variety - of syntaxes are allowed when defining a type as an integer:

- 
-T1 ::= INTEGER
-T2 ::= INTEGER (-2..7)
-T3 ::= INTEGER (0..MAX)
-T4 ::= INTEGER (0<..MAX)
-T5 ::= INTEGER (MIN<..-99)
-T6 ::= INTEGER {red(0),blue(1),white(2)}
-
-

The Erlang representation of an ASN.1 INTEGER is an integer or - an atom if a so called Named Number List (see T6 above) - is specified.

-

Below is an example of Erlang code which assigns values for the - above types:

- 
-T1value = 0,
-T2value = 6,
-T6value1 = blue,
-T6value2 = 0,
-T6value3 = white
-
-

The Erlang variables above are now bound to valid instances of - ASN.1 defined types. This style of value can be passed directly - to the encoder for transformation into a series of bytes.

-

The decoder will return an atom if the value corresponds to a - symbol in the Named Number List.

-
- -
- - REAL -

The following ASN.1 type is used for real numbers:

- 
-R1 ::= REAL
-
-

It can be assigned a value in Erlang as:

- 
-R1value1 = "2.14",
-R1value2 = {256,10,-2},
-
-

In the last line note that the tuple {256,10,-2} is the real number - 2.56 in a special notation, which will encode faster than simply - stating the number as "2.56". The arity three tuple is - {Mantissa,Base,Exponent} i.e. Mantissa * Base^Exponent.

-
- -
- - NULL -

Null is suitable in cases where supply and recognition of a value - is important but the actual value is not.

- 
-Notype ::= NULL
-
-

The NULL type can be assigned in Erlang:

- 
-N1 = 'NULL',
-
-

The actual value is the quoted atom 'NULL'.

-
- -
- - ENUMERATED -

The enumerated type can be used, when the value we wish to - describe, may only take one of a set of predefined values.

- 
-DaysOfTheWeek ::= ENUMERATED { 
-    sunday(1),monday(2),tuesday(3),
-    wednesday(4),thursday(5),friday(6),saturday(7) }
-
-

For example to assign a weekday value in Erlang use the same atom - as in the Enumerations of the type definition:

- 
-Day1 = saturday,
-
-

The enumerated type is very similar to an integer type, when - defined with a set of predefined values. An enumerated type - differs from an integer in that it may only have specified - values, whereas an integer can also have any other value.

-
- -
- - BIT STRING -

The BIT STRING type can be used to model information which - is made up of arbitrary length series of bits. It is intended - to be used for a selection of flags, not for binary files.

- - In ASN.1 BIT STRING definitions may look like: -

- 
-Bits1 ::= BIT STRING
-Bits2 ::= BIT STRING {foo(0),bar(1),gnu(2),gnome(3),punk(14)}
-
-

There are two notations available for representation of - BIT STRING values in Erlang and as input to the encode functions.

- - A bitstring. By default, a BIT STRING with no - symbolic names will be decoded to an Erlang bitstring. - A list of atoms corresponding to atoms in the NamedBitList - in the BIT STRING definition. A BIT STRING with symbolic - names will always be decoded to this format. - -

Example:

- 
-Bits1Val1 = <<0:1,1:1,0:1,1:1,1:1>>,
-Bits2Val1 = [gnu,punk],
-Bits2Val2 = <<2#1110:4>>,
-Bits2Val3 = [bar,gnu,gnome],
-
-

Bits2Val2 and Bits2Val3 above denote the same value.

-

Bits2Val1 is assigned symbolic values. The assignment means - that the bits corresponding to gnu and punk i.e. bits - 2 and 14 are set to 1 and the rest set to 0. The symbolic values - appear as a list of values. If a named value appears, which is not - specified in the type definition, a run-time error will occur.

-

BIT STRINGS may also be sub-typed with, for example, a SIZE - specification:

- 
-Bits3 ::= BIT STRING (SIZE(0..31))
-

This means that no bit higher than 31 can ever be set.

- -
- Deprecated representations for BIT STRING -

In addition to the representations described above, the - following deprecated representations are available if the - specification has been compiled with the - legacy_erlang_types option:

- - A list of binary digits (0 or 1). This format is - accepted as input to the encode functions, and a BIT STRING - will be decoded to this format if the - legacy_bit_string option has been given. - - As {Unused,Binary} where Unused denotes - how many trailing zero-bits 0 to 7 that are unused in the - least significant byte in Binary. This format is - accepted as input to the encode functions, and a BIT - STRING will be decoded to this format if - compact_bit_string has been given. - - A hexadecimal number (or an integer). This format - should be avoided, since it is easy to misinterpret a BIT - STRING value in this format. - - -
-
- -
- - OCTET STRING -

The OCTET STRING is the simplest of all ASN.1 types. The - OCTET STRING only moves or transfers e.g. binary files or other - unstructured information complying to two rules. Firstly, the - bytes consist of octets and secondly, encoding is not - required.

-

It is possible to have the following ASN.1 type definitions:

- 
-O1 ::= OCTET STRING
-O2 ::= OCTET STRING (SIZE(28))
-

With the following example assignments in Erlang:

- 
-O1Val = <<17,13,19,20,0,0,255,254>>,
-O2Val = <<"must be exactly 28 chars....">>,
-

By default, an OCTET STRING is always represented as - an Erlang binary. If the specification has been compiled with - the legacy_erlang_types option, the encode functions - will accept both lists and binaries, and the decode functions - will decode an OCTET STRING to a list.

-
- -
- - Character Strings -

ASN.1 supports a wide variety of character sets. The main difference - between OCTET STRINGS and the Character strings is that OCTET - STRINGS have no imposed semantics on the bytes delivered.

-

However, when using for instance the IA5String (which closely - resembles ASCII) the byte 65 (in decimal - notation) means the character 'A'. -

-

For example, if a defined type is to be a VideotexString and - an octet is received with the unsigned integer value X, then - the octet should be interpreted as specified in the standard - ITU-T T.100,T.101. -

-

The ASN.1 to Erlang compiler - will not determine the correct interpretation of each BER - (Basic Encoding Rules) string octet value with different - Character strings. Interpretation of octets is the - responsibility of the application. Therefore, from the BER - string point of view, octets appear to be very similar to - character strings and are compiled in the same way. -

-

It should be noted that when PER (Packed Encoding Rules) is - used, there is a significant difference in the encoding scheme - between OCTET STRINGS and other strings. The constraints - specified for a type are especially important for PER, where - they affect the encoding. -

-

Here are some examples:

- 
-Digs ::= NumericString (SIZE(1..3))
-TextFile ::= IA5String (SIZE(0..64000))
-

with corresponding Erlang assignments:

- 
-DigsVal1 = "456",
-DigsVal2 = "123",
-TextFileVal1 = "abc...xyz...",
-TextFileVal2 = [88,76,55,44,99,121 .......... a lot of characters here ....]
-

The Erlang representation for "BMPString" and - "UniversalString" is either a list of ASCII values or a list - of quadruples. The quadruple representation associates to the - Unicode standard representation of characters. The ASCII - characters are all represented by quadruples beginning with - three zeros like {0,0,0,65} for the 'A' character. When - decoding a value for these strings the result is a list of - quadruples, or integers when the value is an ASCII character.

- -

The following example shows how it works. We have the following - specification in the file PrimStrings.asn1.

- 
-PrimStrings DEFINITIONS AUTOMATIC TAGS ::=
-BEGIN
-   BMP ::= BMPString
-END
-
- -

Encoding and decoding some strings:

- - 
-1> asn1ct:compile('PrimStrings', [ber]).
-ok
-2> {ok,Bytes1} = 'PrimStrings':encode('BMP', [{0,0,53,53},{0,0,45,56}]).
-{ok,<<30,4,53,54,45,56>>}
-3> 'PrimStrings':decode('BMP', Bytes1).
-{ok,[{0,0,53,53},{0,0,45,56}]}
-4> {ok,Bytes2} = 'PrimStrings':encode('BMP', [{0,0,53,53},{0,0,0,65}]).
-{ok,<<30,4,53,53,0,65>>}
-5> 'PrimStrings':decode('BMP', Bytes2).
-{ok,[{0,0,53,53},65]}
-6> {ok,Bytes3} = 'PrimStrings':encode('BMP', "BMP string").
-{ok,<<30,20,0,66,0,77,0,80,0,32,0,115,0,116,0,114,0,105,0,110,0,103>>}
-7> 'PrimStrings':decode('BMP', Bytes3).
-{ok,"BMP string"}
- -

The UTF8String type is represented as a UTF-8 encoded binary in - Erlang. Such binaries can be created directly using the binary syntax - or by converting from a list of Unicode code points using the - unicode:characters_to_binary/1 function.

- -

Here are some examples showing how UTF-8 encoded binaries can - be created and manipulated:

- - 
-1> Gs = "Мой маленький Гном".
-[1052,1086,1081,32,1084,1072,1083,1077,1085,1100,1082,1080,
- 1081,32,1043,1085,1086,1084]
-2> Gbin = unicode:characters_to_binary(Gs).
-<<208,156,208,190,208,185,32,208,188,208,176,208,187,208,
-  181,208,189,209,140,208,186,208,184,208,185,32,208,147,
-  208,...>>
-3> Gbin = <<"Мой маленький Гном"/utf8>>.
-<<208,156,208,190,208,185,32,208,188,208,176,208,187,208,
-  181,208,189,209,140,208,186,208,184,208,185,32,208,147,
-  208,...>>
-4> Gs = unicode:characters_to_list(Gbin).
-[1052,1086,1081,32,1084,1072,1083,1077,1085,1100,1082,1080,
- 1081,32,1043,1085,1086,1084]
-
- -

See the unicode module - for more details.

- -

In the following example we will use this ASN.1 specification:

- 
-UTF DEFINITIONS AUTOMATIC TAGS ::=
-BEGIN
-   UTF ::= UTF8String
-END
-
- -

Encoding and decoding a string with Unicode characters:

- - 
-5> asn1ct:compile('UTF', [ber]).
-ok
-6> {ok,Bytes1} = 'UTF':encode('UTF', <<"Гном"/utf8>>).
-{ok,<<12,8,208,147,208,189,208,190,208,188>>}
-7> {ok,Bin1} = 'UTF':decode('UTF', Bytes1).
-{ok,<<208,147,208,189,208,190,208,188>>}
-8> io:format("~ts\n", [Bin1]).
-Гном
-ok
-9> unicode:characters_to_list(Bin1).
-[1043,1085,1086,1084]
-
-
- -
- - OBJECT IDENTIFIER -

The OBJECT IDENTIFIER is used whenever a unique identity is required. - An ASN.1 module, a transfer syntax, etc. is identified with an - OBJECT IDENTIFIER. Assume the example below:

- 
-Oid ::= OBJECT IDENTIFIER
-
-

Therefore, the example below is a valid Erlang instance of the - type 'Oid'.

- 
-OidVal1 = {1,2,55},
-
-

The OBJECT IDENTIFIER value is simply a tuple with the - consecutive values which must be integers. -

-

The first value is limited to the values 0, 1 or 2 and the - second value must be in the range 0..39 when the first value - is 0 or 1. -

-

The OBJECT IDENTIFIER is a very important type and it is - widely used within different standards to uniquely identify - various objects. In [], there is an - easy-to-understand description of the usage of - OBJECT IDENTIFIER.

-

-
- -
- - Object Descriptor -

Values of this type can be assigned a value as an ordinary string - like this:

- - 
-      "This is the value of an Object descriptor"
-
- -
- - The TIME Types -

Two different time types are defined within ASN.1, Generalized - Time and UTC (Universal Time Coordinated), both are assigned a - value as an ordinary string within double quotes i.e. - "19820102070533.8".

-

In case of DER encoding the compiler does not check the validity - of the time values. The DER requirements upon those strings is - regarded as a matter for the application to fulfill.

-
- -
- - SEQUENCE -

The structured types of ASN.1 are constructed from other types - in a manner similar to the concepts of array and struct in C. -

- A SEQUENCE in ASN.1 is - comparable with a struct in C and a record in Erlang. - A SEQUENCE may be defined as:

- 
-Pdu ::= SEQUENCE {
-   a INTEGER,
-   b REAL,
-   c OBJECT IDENTIFIER,
-   d NULL }
-

This is a 4-component structure called 'Pdu'. The major format - for representation of SEQUENCE in Erlang is the record format. - For each SEQUENCE and SET in an ASN.1 module an Erlang - record declaration is generated. For Pdu above, a record - like this is defined:

- 
--record('Pdu',{a, b, c, d}).
-

The record declarations for a module M are placed in a - separate M.hrl file.

-

Values can be assigned in Erlang as shown below:

- 
-MyPdu = #'Pdu'{a=22,b=77.99,c={0,1,2,3,4},d='NULL'}.
-

The decode functions will return a record as result when decoding - a SEQUENCE or a SET.

- -

A SEQUENCE and a SET may contain a component - with a DEFAULT key word followed by the actual value that - is the default value. The DEFAULT keyword means that the - application doing the encoding can omit encoding of the value, - thus resulting in fewer bytes to send to the receiving - application.

- -

An application can use the atom asn1_DEFAULT to indicate - that the encoding should be omitted for that position in - the SEQUENCE.

- -

Depending on the encoding rules, the encoder may also compare - the given value to the default value and automatically omit the - encoding if they are equal. How much effort the encoder makes to - to compare the values depends on the encoding rules. The DER - encoding rules forbids encoding a value equal to the default value, - so it has a more thorough and time-consuming comparison than the - encoders for the other encoding rules.

- -

In the following example we will use this ASN.1 specification:

- 
-File DEFINITIONS AUTOMATIC TAGS ::=
-BEGIN
-Seq1 ::= SEQUENCE {
-    a INTEGER DEFAULT 1,
-    b Seq2 DEFAULT {aa TRUE, bb 15}
-}
-
-Seq2 ::= SEQUENCE {
-    aa BOOLEAN,
-    bb INTEGER
-}
-
-Seq3 ::= SEQUENCE {
-    bs BIT STRING {a(0), b(1), c(2)} DEFAULT {a, c}
-}
-END
-

Here is an example where the BER encoder is able to omit encoding - of the default values:

- 
-1> asn1ct:compile('File', [ber]).
-ok
-2> 'File':encode('Seq1', {'Seq1',asn1_DEFAULT,asn1_DEFAULT}).
-{ok,<<48,0>>}
-3> 'File':encode('Seq1', {'Seq1',1,{'Seq2',true,15}}).
-{ok,<<48,0>>}
- -

And here is an example with a named BIT STRING where the BER - encoder will not omit the encoding:

- 
-4> 'File':encode('Seq3', {'Seq3',asn1_DEFAULT).
-{ok,<<48,0>>}
-5> 'File':encode('Seq3', {'Seq3',<<16#101:3>>).
-{ok,<<48,4,128,2,5,160>>}
- -

The DER encoder will omit the encoding for the same BIT STRING:

- 
-6> asn1ct:compile('File', [ber,der]).
-ok
-7> 'File':encode('Seq3', {'Seq3',asn1_DEFAULT).
-{ok,<<48,0>>}
-8> 'File':encode('Seq3', {'Seq3',<<16#101:3>>).
-{ok,<<48,0>>}
-
- -
- - SET -

In Erlang, the SET type is used exactly as SEQUENCE. Note - that if the BER or DER encoding rules are used, decoding a - SET is slower than decoding a SEQUENCE because the components - must be sorted.

-
- -
- Notes about extensibility for SEQUENCE and SET -

When a SEQUENCE or SET contains an extension marker and - extension components like this:

- 
-SExt ::= SEQUENCE {
-           a INTEGER,
-           ...,
-           b BOOLEAN }
-
-

It means that the type may get more components in newer - versions of the ASN.1 spec. In this case it has got a new - component b. Thus, incoming messages that will be decoded - may have more or fever components than this one. -

-

The component b will be treated as - an original component when encoding a message. In this case, as - it is not an optional element, it must be encoded. -

-

During decoding the b field of the record will get the decoded - value of the b - component if present and otherwise the value asn1_NOVALUE.

-
- -
- - CHOICE -

The CHOICE type is a space saver and is similar to the concept of a - 'union' in the C language.

-

Assume:

- 
-SomeModuleName DEFINITIONS AUTOMATIC TAGS ::=
-BEGIN
-T ::= CHOICE {
-        x REAL,
-        y INTEGER,
-        z OBJECT IDENTIFIER }
-END
-

It is then possible to assign values:

- 
-TVal1 = {y,17},
-TVal2 = {z,{0,1,2}},
-
-

A CHOICE value is always represented as the tuple - {ChoiceAlternative, Val} where ChoiceAlternative - is an atom denoting the selected choice alternative. -

- -
- Extensible CHOICE -

When a CHOICE contains an extension marker and the decoder detects - an unknown alternative of the CHOICE the value is represented as:

- 
-{asn1_ExtAlt, BytesForOpenType}
-
-

Where BytesForOpenType is a list of bytes constituting the - encoding of the "unknown" CHOICE alternative.

-
-
- -
- - SET OF and SEQUENCE OF -

The SET OF and SEQUENCE OF types correspond to the concept of an array - found in several programming languages. The Erlang syntax for - both of these types is straight forward. For example:

- 
-Arr1 ::= SET SIZE (5) OF INTEGER (4..9) 
-Arr2 ::= SEQUENCE OF OCTET STRING
-

We may have the following in Erlang:

- 
-Arr1Val = [4,5,6,7,8],
-Arr2Val = ["abc",[14,34,54],"Octets"],
-

Please note that the definition of the SET OF type implies that - the order of the components is undefined, but in practice there is - no difference between SET OF and SEQUENCE OF. The ASN.1 compiler - for Erlang does not randomize the order of the SET OF components - before encoding.

-

However, in case of a value of the type SET OF, the DER - encoding format requires the elements to be sent in ascending - order of their encoding, which implies an expensive sorting - procedure in run-time. Therefore it is strongly recommended to - use SEQUENCE OF instead of SET OF if it is possible.

-
- -
- - ANY and ANY DEFINED BY -

The types ANY and ANY DEFINED BY have been removed - from the standard since 1994. It is recommended not to use - these types any more. They may, however, exist in some old ASN.1 - modules. - The idea with this type was to leave a "hole" in a definition where - one could put unspecified data of any kind, even non ASN.1 data.

-

A value of this type is encoded as an open type.

-

Instead of ANY/ANY DEFINED BY one should use - information object class, table constraints and - parameterization. In particular the construct - TYPE-IDENTIFIER.@Type accomplish the same as the - deprecated ANY.

-

See also Information object

-
- -
- - EXTERNAL, EMBEDDED PDV and CHARACTER STRING -

These types are used in presentation layer negotiation. They are - encoded according to their associated type, see [].

-

The EXTERNAL type had a slightly different associated type - before 1994. [] states that encoding shall follow - the older associate type. Therefore does generated encode/decode - functions convert values of the newer format to the older format - before encoding. This implies that it is allowed to use - EXTERNAL type values of either format for encoding. Decoded - values are always returned on the newer format.

-
- -
- Embedded Named Types -

The structured types previously described may very well have other named types - as their components. The general syntax to assign a value to the component C - of a named ASN.1 type T in Erlang is the record syntax - #'T'{'C'=Value}. - Where Value may be a value of yet another type T2.

-

For example:

- 
-EmbeddedExample DEFINITIONS AUTOMATIC TAGS ::=
-BEGIN
-B ::= SEQUENCE {
-        a Arr1,
-        b T }
-
-Arr1 ::= SET SIZE (5) OF INTEGER (4..9) 
-
-T ::= CHOICE {
-        x REAL,
-        y INTEGER,
-        z OBJECT IDENTIFIER }
-        END
-

The SEQUENCE b can be encoded like this in Erlang:

- 
-1> 'EmbeddedExample':encode('B', {'B',[4,5,6,7,8],{x,"7.77"}}).
-{ok,<<5,56,0,8,3,55,55,55,46,69,45,50>>}
-
-
- -
- Naming of Records in .hrl Files -

When an ASN.1 specification is compiled all defined types of - type SET or SEQUENCE will result in a corresponding record in the - generated hrl file. This is because the values for SET/SEQUENCE - as mentioned in sections above are represented as records.

-

Though there are some special cases of this functionality that - are presented below.

- -
- Embedded Structured Types -

It is also possible in ASN.1 to have components that are themselves - structured types. - For example, it is possible to have:

- 
-Emb ::= SEQUENCE {
-    a SEQUENCE OF OCTET STRING,
-    b SET {
-       a INTEGER,
-       b INTEGER DEFAULT 66},
-    c CHOICE {
-       a INTEGER,
-       b FooType } }
-
-FooType ::= [3] VisibleString
-

The following records are generated because of the type Emb:

- 
--record('Emb,{a, b, c}).
--record('Emb_b',{a, b = asn1_DEFAULT}). % the embedded SET type
-
-

Values of the Emb type can be assigned like this:

- -V = #'Emb'{a=["qqqq",[1,2,255]], - b = #'Emb_b'{a=99}, - c ={b,"Can you see this"}}. - -

For an embedded type of type SEQUENCE/SET in a SEQUENCE/SET - the record name is extended with an underscore and the component - name. If the embedded structure is deeper with SEQUENCE, SET or - CHOICE types in the line, each component-/alternative-name will - be added to the record-name.

-

For example:

- 
-Seq ::= SEQUENCE{
-    a CHOICE{
-        b SEQUENCE {
-           c  INTEGER
-        }
-    }
-}
-

will result in the following record:

- 
--record('Seq_a_b',{c}).
-

If the structured type has a component with an embedded - SEQUENCE OF/SET OF which embedded type in turn is a - SEQUENCE/SET it will give a record with the SEQOF/SETOF - addition as in the following example:

- 
-Seq ::= SEQUENCE {
-    a SEQUENCE OF SEQUENCE {
-           b
-               }
-    c SET OF SEQUENCE {
-           d
-               }
-}
-

This results in the records:

- 
--record('Seq_a_SEQOF'{b}).
--record('Seq_c_SETOF'{d}).
-

A parameterized type should be considered as an embedded - type. Each time a such type is referenced an instance of it is - defined. Thus in the following example a record with name - 'Seq_b' is generated in the .hrl file and used to hold - values.

- 
-Seq ::= SEQUENCE {
-    b PType{INTEGER}
-}
-
-PType{T} ::= SEQUENCE{
-    id T
-}
-
- -
- Recursive Types -

Types may refer to themselves. Suppose:

- 
-Rec ::= CHOICE {
-     nothing NULL,
-     something SEQUENCE {
-          a INTEGER,
-          b OCTET STRING,
-          c Rec }}
-

This type is recursive; that is, it refers to itself. This is allowed - in ASN.1 and the ASN.1-to-Erlang compiler supports this recursive - type. A value for this type is assigned in Erlang as shown below:

- 
-V = {something,#'Rec_something'{a = 77, 
-                                b = "some octets here", 
-                                c = {nothing,'NULL'}}}.
-
-
- -
- ASN.1 Values -

Values can be assigned to ASN.1 type within the ASN.1 code - itself, as opposed to the actions taken in the previous chapter where - a value was assigned to an ASN.1 type in Erlang. The full value - syntax of ASN.1 is supported and [X.680] describes in detail how - to assign values in ASN.1. Below is a short example:

- 
-TT ::= SEQUENCE {
-   a INTEGER,
-   b SET OF OCTET STRING }
-
-tt TT ::= {a 77,b {"kalle","kula"}}
-

The value defined here could be used in several ways. - Firstly, it could be used as the value in some DEFAULT component:

- 
-SS ::= SET {
-    s OBJECT IDENTIFIER,
-    val TT DEFAULT tt }
-

It could also be used from inside an Erlang program. If the above ASN.1 - code was defined in ASN.1 module Values, then the ASN.1 value - tt can be reached from Erlang as - a function call to 'Values':tt() as in the example below.

- 
-1> Val = 'Values':tt().
-{'TT',77,["kalle","kula"]}
-2> {ok,Bytes} = 'Values':encode('TT',Val).
-{ok,<<48,18,128,1,77,161,13,4,5,107,97,108,108,101,4,4,
-      107,117,108,97>>}
-4> 'Values':decode('TT',Bytes).
-{ok,{'TT',77,["kalle","kula"]}}
-5>
-
-

The above example shows that a function is generated by the compiler - that returns a valid Erlang representation of the value, even though - the value is of a complex type.

-

Furthermore, there is a macro generated for each value in the .hrl - file. So, the defined value tt can also be extracted by - ?tt in application code.

-
- -
- Macros -

MACRO is not supported as the the type is no longer part of the - ASN.1 standard.

-
- -
- - ASN.1 Information Objects (X.681) -

Information Object Classes, Information Objects and Information - Object Sets (in the following called classes, objects and - object sets respectively) are defined in the standard - definition []. In the following only a brief - explanation is given.

-

These constructs makes it possible to define open types, - i.e. values of that type can be of any ASN.1 type. It is also - possible to define relationships between different types and - values, since classes can hold types, values, objects, object - sets and other classes in its fields. - An Information Object Class may be defined in ASN.1 as:

- 
-GENERAL-PROCEDURE ::= CLASS {
-      &Message,
-      &Reply               OPTIONAL,
-      &Error               OPTIONAL,
-      &id          PrintableString UNIQUE
-}
-WITH SYNTAX {
-      NEW MESSAGE     &Message
-      [REPLY           &Reply]
-      [ERROR           &Error]
-      ADDRESS          &id
-}
-

An object is an instance of a class and an object set is a set - containing objects of one specified class. A definition may look like - below.

-

The object object1 is an instance of the CLASS - GENERAL-PROCEDURE and has one type field and one fixed type value - field. The object object2 also has an OPTIONAL field ERROR, - which is a type field.

- 
-object1 GENERAL-PROCEDURE ::= {
-    NEW MESSAGE      PrintableString
-    ADDRESS          "home"
-}
-
-object2 GENERAL-PROCEDURE ::= {
-    NEW MESSAGE INTEGER
-    ERROR INTEGER
-    ADDRESS "remote"
-}
-

The field ADDRESS is a UNIQUE field. Objects in an object set must - have unique values in their UNIQUE field, as in GENERAL-PROCEDURES:

- 
-GENERAL-PROCEDURES GENERAL-PROCEDURE ::= {
-    object1 | object2}
-

One can not encode a class, object or object set, only referring to - it when defining other ASN.1 entities. Typically one refers to a - class and to object sets by table constraints and component - relation constraints [] in ASN.1 types, as in:

- 
-StartMessage  ::= SEQUENCE {
-    msgId  GENERAL-PROCEDURE.&id  ({GENERAL-PROCEDURES}),
-    content GENERAL-PROCEDURE.&Message ({GENERAL-PROCEDURES}{@msgId}),
-    }
-

In the type StartMessage the constraint following the - content field tells that in a value of type - StartMessage the value in the content field must - come from the same object that is chosen by the msgId - field.

-

So, the value #'StartMessage'{msgId="home",content="Any Printable String"} is legal to encode as a StartMessage - value, while the value #'StartMessage'{msgId="remote", content="Some String"} is illegal since the constraint - in StartMessage tells that when you have chosen a value from a - specific object in the object set GENERAL-PROCEDURES in the - msgId field you have to choose a value from that same object in - the content field too. In this second case it should have been - any INTEGER value.

-

StartMessage can in the content field be - encoded with a value of any type that an object in the - GENERAL-PROCEDURES object set has in its NEW MESSAGE field. This field refers to a type field - &Message in the class. The msgId field is always - encoded as a PrintableString, since the field refers to a fixed type - in the class.

-

In practice, object sets are usually declared to be extensible so - so that more objects can be added to the set later. Extensibility is - indicated like this:

- 
-GENERAL-PROCEDURES GENERAL-PROCEDURE ::= {
-    object1 | object2, ...}
-

When decoding a type that uses an extensible set constraint, - there is always the possibility that the value in the UNIQUE - field is unknown (i.e. the type has been encoded with a later - version of the ASN.1 specification). When that happens, the - unencoded data will be returned wrapped in a tuple like this:

- - 
-{asn1_OPENTYPE,Binary}
-

where Binary is an Erlang binary that contains the encoded - data. (If the option legacy_erlang_types has been given, - just the binary will be returned.)

-
- -
- Parameterization (X.683) -

Parameterization, which is defined in the standard [], can be used when defining types, values, value - sets, information object classes, information objects or - information object sets. - A part of a definition can be supplied as a parameter. For - instance, if a Type is used in a definition with certain - purpose, one want the type-name to express the intention. This - can be done with parameterization.

-

When many types (or another ASN.1 entity) only differs in some - minor cases, but the structure of the types are similar, only - one general type can be defined and the differences may be supplied - through parameters.

-

One example of use of parameterization is:

- 
-General{Type} ::= SEQUENCE
-{
-     number     INTEGER,
-     string     Type
-}
-      
-T1 ::= General{PrintableString}
-
-T2 ::= General{BIT STRING}
-
-

An example of a value that can be encoded as type T1 is {12,"hello"}.

-

Note that the compiler does not generate encode/decode functions for - parameterized types, but only for the instances of the parameterized - types. Therefore, if a file contains the types General{}, T1 and T2 above, - encode/decode functions will only be generated for T1 and T2. -

-
- - diff --git a/lib/asn1/doc/src/asn1ct.xml b/lib/asn1/doc/src/asn1ct.xml index 32ff2d52cf..4e0bf055fc 100644 --- a/lib/asn1/doc/src/asn1ct.xml +++ b/lib/asn1/doc/src/asn1ct.xml @@ -35,43 +35,45 @@ ASN.1 compiler and compile-time support functions

The ASN.1 compiler takes an ASN.1 module as input and generates a - corresponding Erlang module which can encode and decode the data-types - specified. Alternatively the compiler takes a specification module - (se below) specifying all input modules and generates one module with - encode/decode functions. There are also some generic functions which - can be used in during development of applications which handles ASN.1 - data (encoded as BER or PER).

+ corresponding Erlang module, which can encode and decode the specified + data types. Alternatively, the compiler takes a specification module + specifying all input modules, and generates a module with + encode/decode functions. In addition, some generic functions + can be used during development of applications that handles ASN.1 + data (encoded as BER or PER).

+ -

By default in OTP 17, the representation of the BIT STRING - and OCTET STRING types as Erlang terms have changed. BIT - STRING values are now Erlang bitstrings and OCTET STRING values - are binaries. Also, an undecoded open type will now be wrapped in - a asn1_OPENTYPE tuple. For details see BIT STRING, OCTET STRING, and - ASN.1 Information Objects in User's Guide.

-

To revert to the old representation of the types, use the - legacy_erlang_types option.

+

By default in OTP 17, the representation of the BIT STRING + and OCTET STRING types as Erlang terms were changed. BIT + STRING values are now Erlang bit strings and OCTET STRING + values are binaries. Also, an undecoded open type is now wrapped in + an asn1_OPENTYPE tuple. For details, see BIT STRING, OCTET STRING, and + ASN.1 Information Objects in the User's Guide.

+

To revert to the old representation of the types, use option + legacy_erlang_types.

 + -

In R16, the options have been simplified. The back-end is chosen +

In OTP R16, the options were simplified. The back end is chosen using one of the options ber, per, or uper. - The options optimize, nif, and driver options - are no longer necessary (and the ASN.1 compiler will print a - warning if they are used). The options ber_bin, per_bin, - and uper_bin options will still work, but will print a warning. + Options optimize, nif, and driver options + are no longer necessary (and the ASN.1 compiler generates a + warning if they are used). Options ber_bin, per_bin, + and uper_bin options still work, but generates a warning.

-

Another change in R16 is that the generated encode/2 - function always returns a binary. - The encode/2 function for the BER back-end used to return - an iolist.

+

Another change in OTP R16 is that the generated function + encode/2 always returns a binary. Function encode/2 + for the BER back end used to return an iolist.

 + compile(Asn1module) -> ok | {error, Reason} compile(Asn1module, Options) -> ok | {error, Reason} - Compile an ASN.1 module and generate encode/decode functions according to the encoding rules BER or PER. + Compiles an ASN.1 module and generates encode/decode functions according to encoding rules BER or PER. Asn1module = atom() | string() Options = [Option| OldOption] @@ -85,79 +87,82 @@ Prefix = string() -

Compiles the ASN.1 module Asn1module and generates an - Erlang module Asn1module.erl with encode and decode +

Compiles the ASN.1 module Asn1module and generates + an Erlang module Asn1module.erl with encode and decode functions for the types defined in Asn1module. For each - ASN.1 value defined in the module an Erlang function which + ASN.1 value defined in the module, an Erlang function that returns the value in Erlang representation is generated.

-

If Asn1module is a filename without extension first - ".asn1" is assumed, then ".asn" and finally +

If Asn1module is a filename without extension, first + ".asn1" is assumed, then ".asn", and finally ".py" (to be compatible with the old ASN.1 compiler). - Of course Asn1module can be a full pathname (relative or + Asn1module can be a full pathname (relative or absolute) including filename with (or without) extension.

-

If one wishes to compile a set of Asn1 modules into one - Erlang file with encode/decode functions one has to list all +

If it is needed to compile a set of ASN.1 modules into an + Erlang file with encode/decode functions, ensure to list all involved files in a configuration file. This configuration - file must have a double extension ".set.asn", (".asn" can - alternatively be ".asn1" or ".py"). The input files' names - must be listed, within quotation marks (""), one at each row + file must have a double extension ".set.asn" + (".asn" can alternatively be ".asn1" or ".py"). + List the input file names + within quotation marks (""), one at each row in the file. If the input files are File1.asn, - File2.asn and File3.asn the configuration file - shall look like:

+ File2.asn, and File3.asn, the configuration file + must look as follows:

 File1.asn
 File2.asn
-File3.asn
-

The output files will in this case get their names from the - configuration file. If the configuration file has the name - SetOfFiles.set.asn the name of the output files will be - SetOfFiles.hrl, SetOfFiles.erl and SetOfFiles.asn1db.

-

Sometimes in a system of ASN.1 modules there are different - default tag modes, e.g. AUTOMATIC, IMPLICIT or EXPLICIT. The - multi file compilation resolves the default tagging as if +File3.asn +

The output files in this case get their names from the + configuration file. If the configuration file is named + SetOfFiles.set.asn, the names of the output files are + SetOfFiles.hrl, SetOfFiles.erl, and SetOfFiles.asn1db.

+

Sometimes in a system of ASN.1 modules, different + default tag modes, for example, AUTOMATIC, IMPLICIT, + or EXPLICIT. The + multi-file compilation resolves the default tagging as if the modules were compiled separately.

-

Another unwanted effect that may occur in multi file compilation - is name collisions. The compiler solves this problem in two - ways: If the definitions are identical then the output module - keeps only one definition with the original name. But if - definitions only have same name and differs in the definition, - then they will be renamed. The new names will be the definition - name and the original module name concatenated.

-

If any name collision have occurred the compiler reports a - "NOTICE: ..." message that tells if a definition was renamed, +

Name collisions is another unwanted effect that can occur in + multi file-compilation. The compiler solves this problem in one + of two ways:

+ + If the definitions are identical, the output module + keeps only one definition with the original name. + If the definitions have the same name and differs in the + definition, they are renamed. The new names are the definition + name and the original module name concatenated. + +

If a name collision occurs, the compiler reports a + "NOTICE: ..." message that tells if a definition was renamed, and the new name that must be used to encode/decode data.

- -

- Options is a list with options specific for the asn1 +

Options is a list with options specific for the ASN.1 compiler and options that are applied to the Erlang compiler. - The latter are those that not is recognized as asn1 specific. - Available options are: + The latter are not recognized as ASN.1 specific. The + available options are as follows:

ber | per | uper

The encoding rule to be used. The supported encoding rules - are BER (Basic Encoding Rules), - PER aligned (Packed Encoding Rules) and PER unaligned. - If the encoding rule option is omitted ber + are Basic Encoding Rules (BER), + Packed Encoding Rules (PER) aligned, and PER unaligned. + If the encoding rule option is omitted, ber is the default.

The generated Erlang module always gets the same name - as the ASN.1 module and as a consequence of this only one - encoding rule per ASN.1 module can be used at runtime. + as the ASN.1 module. Therefore, only one + encoding rule per ASN.1 module can be used at runtime.

der

- By this option the Distinguished Encoding Rules (DER) is chosen. + With this option the Distinguished Encoding Rules (DER) is chosen. DER is regarded as a specialized variant of the BER encoding - rule, therefore the der option only makes sense together - with the ber option. + rule. Therefore, this option only makes sense together + with option ber. This option sometimes adds sorting and value checks when encoding, which implies a slower encoding. The decoding routines are the same @@ -167,118 +172,123 @@ File3.asn compact_bit_string

- The BIT STRING type will be decoded to the "compact notation". + The BIT STRING type is decoded to "compact notation". This option is not recommended for new code.

-

For details see - - BIT STRING type section in the Users Guide - . +

For details, see Section + + BIT STRING in the User's Guide.

-

This option implies the legacy_erlang_types option.

+

This option implies option legacy_erlang_types.

 legacy_bit_string

- The BIT STRING type will be decoded to the legacy - format, i.e. a list of zeroes and ones. + The BIT STRING type is decoded to the legacy + format, that is, a list of zeroes and ones. This option is not recommended for new code.

-

For details see - - BIT STRING type section in the Users Guide - . -

This option implies the legacy_erlang_types option.

-

+

For details, see Section + BIT STRING + in the User's Guide

+

This option implies option legacy_erlang_types.

 legacy_erlang_types -

Use the same Erlang types to represent BIT STRING and - OCTET STRING as in R16. For details see BIT STRING and - OCTET - STRING in User's Guide.

-

This option is not recommended for - new code.

+

Use the same Erlang types to represent BIT STRING and + OCTET STRING as in OTP R16.

+

For details, see Section BIT STRING and Section + OCTET + STRING in the User's Guide.

+

This option is not recommended for new code.

 {n2n, EnumTypeName}

- Tells the compiler to generate functions for conversion between - names (as atoms) and numbers and vice versa for the EnumTypeName specified. There can be multiple occurrences of this option in order to specify several type names. The type names must be declared as ENUMERATIONS in the ASN.1 spec. - If the EnumTypeName does not exist in the ASN.1 spec the - compilation will stop with an error code. - The generated conversion functions are named + Tells the compiler to generate functions for conversion + between names (as atoms) and numbers and conversely for + the specified EnumTypeName. There can be multiple + occurrences of this option to specify several type names. + The type names must be declared as ENUMERATIONS in + the ASN.1 specification.

+

+ If EnumTypeName does not exist in the ASN.1 specification, + the compilation stops with an error code.

+

+ The generated conversion functions are named name2num_EnumTypeName/1 and num2name_EnumTypeName/1.

noobj -

Do not compile (i.e do not produce object code) the generated - .erl file. If this option is omitted the generated Erlang module - will be compiled.

+

Do not compile (that is, do not produce object code) the + generated .erl file. If this option is omitted, the + generated Erlang module is compiled.

 {i, IncludeDir}

Adds IncludeDir to the search-path for - .asn1db and asn1 source files. The compiler tries - to open a .asn1db file when a module imports - definitions from another ASN.1 module. If no - .asn1db file is found the asn1 source file is - parsed. Several {i, IncludeDir} can be given. + .asn1db and ASN.1 source files. The compiler + tries to open an .asn1db file when a module imports + definitions from another ASN.1 module. If no + .asn1db file is found, the ASN.1 source file is + parsed. Several {i, IncludeDir} can be given.

{outdir, Dir} -

Specifies the directory Dir where all generated files - shall be placed. If omitted the files are placed in the - current directory.

+

Specifies directory Dir where all generated files + are to be placed. If this option is omitted, the files are + placed in the current directory.

 asn1config -

When one of the specialized decodes, exclusive or - selective decode, is wanted one has to give instructions in - a configuration file. The option asn1config enables - specialized decodes and takes the configuration file, which - has the same name as the ASN.1 spec but with extension - .asn1config, in concern. +

When using one of the specialized decodes, exclusive or + selective decode, instructions must be given in + a configuration file. Option asn1config enables + specialized decodes and takes the configuration file in + concern. The configuration file has + the same name as the ASN.1 specification, but with extension + .asn1config.

-

The instructions for exclusive decode must follow the - instruction and grammar in the User's Guide. +

For instructions for exclusive decode, see Section + Exclusive + Decode in the User's Guide.

-

You can also find the instructions for selective decode - in the - User's Guide. +

For instructions for selective decode, see Section + Selective + Decode in the User's Guide.

undec_rest -

A buffer that holds a message, being decoded may - also have some following bytes. Now it is possible to get - those following bytes returned together with the decoded - value. If an asn1 spec is compiled with this option a tuple - {ok, Value, Rest} is returned. Rest may be a +

A buffer that holds a message, being decoded it can also + have some following bytes. Those following bytes can now + be returned together with the decoded value. If an + ASN.1 specification is compiled with this option, a tuple + {ok, Value, Rest} is returned. Rest can be a list or a binary. Earlier versions of the compiler ignored those following bytes.

 no_ok_wrapper -

If this option is given, the generated encode/2 - and decode/2 functions will not wrap a successful +

With this option, the generated encode/2 + and decode/2 functions do not wrap a successful return value in an {ok,...} tuple. If any error - occurs, there will be an exception.

+ occurs, an exception will be raised.

 {macro_name_prefix, Prefix}

All macro names generated by the compiler are prefixed with - Prefix. This is useful when multiple protocols that contains + Prefix. This is useful when multiple protocols that contain macros with identical names are included in a single module.

 {record_name_prefix, Prefix}

All record names generated by the compiler are prefixed with - Prefix. This is useful when multiple protocols that contains + Prefix. This is useful when multiple protocols that contain records with identical names are included in a single module.

 verbose @@ -291,27 +301,27 @@ File3.asn

Causes warnings to be treated as errors.

 -

Any additional option that is applied will be passed to - the final step when the generated .erl file is compiled. +

Any more option that is applied is passed to + the final step when the generated .erl file is compiled.

The compiler generates the following files:

- -

Asn1module.hrl (if any SET or SEQUENCE is defined)

+ Asn1module.hrl (if any SET or SEQUENCE + is defined) - -

Asn1module.erl the Erlang module with encode, decode and value functions.

+ Asn1module.erl - Erlang module with encode, decode, + and value functions - -

Asn1module.asn1db intermediate format used by the compiler when modules IMPORTS - definitions from each other.

+ Asn1module.asn1db - Intermediate format used by the + compiler when modules IMPORT definitions from each other. + encode(Module, Type, Value)-> {ok, Bytes} | {error, Reason} - Encode an ASN.1 value. + Encodes an ASN.1 value. Module = Type = atom() Value = term() @@ -319,11 +329,11 @@ File3.asn Reason = term() -

Encodes Value of Type defined in the ASN.1 module - Module. To get as fast execution as possible the - encode function only performs rudimentary tests that the input - Value - is a correct instance of Type. The length of strings is for example +

Encodes Value of Type defined in the ASN.1 module + Module. To get as fast execution as possible, the + encode function performs only the rudimentary tests that input + Value is a correct instance of Type. So, for example, + the length of strings is not always checked. Returns {ok, Bytes} if successful or {error, Reason} if an error occurred.

@@ -331,6 +341,7 @@ File3.asn Use Module:encode(Type, Value) instead.

 + decode(Module, Type, Bytes) -> {ok, Value} | {error, Reason} Decode from Bytes into an ASN.1 value. @@ -346,26 +357,28 @@ File3.asn Use Module:decode(Type, Bytes) instead.

 + value(Module, Type) -> {ok, Value} | {error, Reason} - Create an ASN.1 value for test purposes. + Creates an ASN.1 value for test purposes. Module = Type = atom() Value = term() Reason = term() -

Returns an Erlang term which is an example of a valid Erlang - representation of a value of the ASN.1 type Type. The value +

Returns an Erlang term that is an example of a valid Erlang + representation of a value of the ASN.1 type Type. The value is a random value and subsequent calls to this function will for most types return different values.

 + test(Module) -> ok | {error, Reason} test(Module, Type | Options) -> ok | {error, Reason} test(Module, Type, Value | Options) -> ok | {error, Reason} - Perform a test of encode and decode for types in an ASN.1 module. + Performs a test of encode and decode for types in an ASN.1 module. Module = Type = atom() Value = term() @@ -376,9 +389,8 @@ File3.asn

Performs a test of encode and decode of types in Module. The generated functions are called by this function. This function is useful during test to secure that the generated - encode and decode functions and the general runtime support work - as expected.

- + encode and decode functions as well as the general runtime support + work as expected.

test/1 iterates over all types in Module.

@@ -390,14 +402,12 @@ File3.asn

test/3 tests type Type with Value.

 - -

Schematically the following happens for each type in the module:

+

Schematically, the following occurs for each type in the module:

{ok, Value} = asn1ct:value(Module, Type), {ok, Bytes} = asn1ct:encode(Module, Type, Value), {ok, Value} = asn1ct:decode(Module, Type, Bytes). - -

The test functions utilizes the *.asn1db files +

The test functions use the *.asn1db files for all included modules. If they are located in a different directory than the current working directory, use the include option to add paths. This is only needed when automatically diff --git a/lib/asn1/doc/src/asn1rt.xml b/lib/asn1/doc/src/asn1rt.xml index 3cf56b01ca..f5c334c2ac 100644 --- a/lib/asn1/doc/src/asn1rt.xml +++ b/lib/asn1/doc/src/asn1rt.xml @@ -46,7 +46,7 @@ decode(Module,Type,Bytes) -> {ok,Value}|{error,Reason} - Decode from bytes into an ASN.1 value. + Decodes from Bytes into an ASN.1 value. Module = Type = atom() Value = Reason = term() @@ -61,7 +61,7 @@ encode(Module,Type,Value)-> {ok,Bytes} | {error,Reason} - Encode an ASN.1 value. + Encodes an ASN.1 value. Module = Type = atom() Value = term() @@ -69,12 +69,12 @@ Reason = term() -

Encodes Value of Type defined in the ASN.1 +

Encodes Value of Type defined in the ASN.1 module Module. Returns a binary if successful. To get - as fast execution as possible the encode function only - performs rudimentary tests that the input Value is a - correct instance of Type. The length of strings is, for - example, not always checked.

+ as fast execution as possible, the encode function performs + only the rudimentary test that input Value is a correct + instance of Type. For example, the length of strings is + not always checked.

Use Module:encode(Type, Value) instead of this function.

 @@ -88,23 +88,23 @@ Reason = term() -

info/1 returns the version of the asn1 compiler that was +

Returns the version of the ASN.1 compiler that was used to compile the module. It also returns the compiler options - that was used.

+ that were used.

Use Module:info() instead of this function.

 utf8_binary_to_list(UTF8Binary) -> {ok,UnicodeList} | {error,Reason} - Transforms an utf8 encoded binary to a unicode list. + Transforms an UTF8 encoded binary to a unicode list. UTF8Binary = binary() UnicodeList = [integer()] Reason = term() -

utf8_binary_to_list/1 Transforms a UTF8 encoded binary +

Transforms a UTF8 encoded binary to a list of integers, where each integer represents one character as its unicode value. The function fails if the binary is not a properly encoded UTF8 string.

@@ -114,14 +114,14 @@ utf8_list_to_binary(UnicodeList) -> {ok,UTF8Binary} | {error,Reason} - Transforms an unicode list ot an utf8 binary. + Transforms an unicode list to a UTF8 binary. UnicodeList = [integer()] UTF8Binary = binary() Reason = term() -

utf8_list_to_binary/1 Transforms a list of integers, +

Transforms a list of integers, where each integer represents one character as its unicode value, to a UTF8 encoded binary.

Use unicode:characters_to_binary/1 instead of this function.

diff --git a/lib/asn1/doc/src/part.xml b/lib/asn1/doc/src/part.xml index 735ec2e616..104aeb1f34 100644 --- a/lib/asn1/doc/src/part.xml +++ b/lib/asn1/doc/src/part.xml @@ -29,11 +29,14 @@ part.sgml -

The Asn1 application - contains modules with compile-time and run-time support for ASN.1. +

The ASN.1 application + contains modules with compile-time and runtime support for + Abstract Syntax Notation One (ASN.1).

- + + + diff --git a/lib/asn1/doc/src/ref_man.xml b/lib/asn1/doc/src/ref_man.xml index 0a0ed5416a..e157f542f3 100644 --- a/lib/asn1/doc/src/ref_man.xml +++ b/lib/asn1/doc/src/ref_man.xml @@ -21,7 +21,7 @@ - Asn1 Reference Manual + ASN.1 Reference Manual OTP Team 1997-10-04 @@ -29,8 +29,8 @@ application.sgml -

The Asn1 application - contains modules with compile-time and run-time support for ASN.1.

+

The ASN.1 application + contains modules with compile-time and runtime support for ASN.1.

 -- cgit v1.2.3 From 5c9cab4be276b09f9c119f5d678f896b8043f015 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Fri, 24 Apr 2015 12:18:31 +0200 Subject: asn1_spec: Correct obsolete details about compiler options There is now only one BER back-end, and there is no 'optimize' option. --- lib/asn1/doc/src/asn1_spec.xmlsrc | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) (limited to 'lib') diff --git a/lib/asn1/doc/src/asn1_spec.xmlsrc b/lib/asn1/doc/src/asn1_spec.xmlsrc index 5bee9f0075..e050dff553 100644 --- a/lib/asn1/doc/src/asn1_spec.xmlsrc +++ b/lib/asn1/doc/src/asn1_spec.xmlsrc @@ -46,13 +46,8 @@ Exclusive decode Selected decode -

So far this functionality is only provided when using the - optimized BER_BIN version, that is, when compiling with - options ber_bin and optimize. It also works - with optionnif. We do not intent to make this functionality - available in the default BER version, but possibly in the - PER_BIN version (per_bin). -

+

This functionality is only provided when using BER + (option ber).

Exclusive Decode @@ -213,9 +208,9 @@ Name = atom()

Compiling GUI.asn including the configuration file is done as follows:

-unix> erlc -bber_bin +optimize +asn1config GUI.asn
+unix> erlc -bber +asn1config GUI.asn
 
-erlang> asn1ct:compile('GUI',[ber_bin,optimize,asn1config]).
+erlang> asn1ct:compile('GUI', [ber,asn1config]).

The module can be used as follows:

 1> Button_Msg = {'Button',123,true}.
-- 
cgit v1.2.3


From 1e115b3e972bb8c23504ee75ad8fb2e202a6758a Mon Sep 17 00:00:00 2001
From: Lars Thorsen 
Date: Fri, 24 Apr 2015 09:51:50 +0200
Subject: [orber, cos*] Remove usage of erlang:now()

---
 lib/cosEvent/src/oe_CosEventComm_PullerS_impl.erl  |  5 ++-
 lib/cosEventDomain/src/cosEventDomainApp.erl       | 34 ++--------------
 lib/cosFileTransfer/src/cosFileTransferApp.erl     |  7 ++--
 lib/cosNotification/src/CosNotification_Common.erl | 47 +++++++++++++++-------
 .../src/CosNotification_Definitions.hrl            |  6 ++-
 lib/cosNotification/src/PullerSupplier_impl.erl    |  4 +-
 lib/cosNotification/src/cosNotificationApp.erl     | 16 +-------
 .../src/cosNotification_eventDB.erl                | 32 +++++++--------
 .../src/CosPropertyService_PropertySetDef_impl.erl |  6 ++-
 lib/cosProperty/src/cosProperty.erl                |  7 ++--
 lib/cosTime/src/CosTime_TimeService_impl.erl       |  2 +-
 lib/cosTime/src/cosTime.erl                        |  5 ++-
 lib/cosTime/src/cosTimeApp.hrl                     |  2 +-
 .../CosTransactions_TransactionFactory_impl.erl    |  6 +--
 lib/cosTransactions/src/ETraP_Common.erl           | 17 ++++----
 lib/cosTransactions/src/ETraP_Server_impl.erl      |  5 ++-
 .../CosNaming/CosNaming_NamingContextExt_impl.erl  | 10 +++--
 lib/orber/src/cdr_decode.erl                       |  8 ++--
 lib/orber/src/corba.erl                            |  6 ++-
 lib/orber/src/orber_ifr_utils.erl                  |  7 ++--
 lib/orber/src/orber_objectkeys.erl                 | 12 +++---
 lib/orber/src/orber_socket.erl                     |  5 +--
 lib/orber/src/orber_web_server.erl                 |  8 ++--
 23 files changed, 122 insertions(+), 135 deletions(-)

(limited to 'lib')

diff --git a/lib/cosEvent/src/oe_CosEventComm_PullerS_impl.erl b/lib/cosEvent/src/oe_CosEventComm_PullerS_impl.erl
index 5f2733e72d..9c22eafaab 100644
--- a/lib/cosEvent/src/oe_CosEventComm_PullerS_impl.erl
+++ b/lib/cosEvent/src/oe_CosEventComm_PullerS_impl.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2001-2009. All Rights Reserved.
+%% Copyright Ericsson AB 2001-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -251,7 +251,8 @@ send_sync(_OE_This, _OE_From, State, Any) ->
 store_event(DB, Max, Event) ->
     case ets:info(DB, size) of
 	CurrentSize when CurrentSize < Max -> 
-	    ets:insert(DB, {now(), Event}); 
+	    ets:insert(DB, {{erlang:system_time(), erlang:unique_integer([positive])},
+			    Event}); 
 	_ ->
 	    orber:dbg("[~p] oe_CosEventComm_PullerS:store_event(~p); DB full drop event.", 
 		      [?LINE, Event], ?DEBUG_LEVEL),
diff --git a/lib/cosEventDomain/src/cosEventDomainApp.erl b/lib/cosEventDomain/src/cosEventDomainApp.erl
index 734e4deccb..86069d9e09 100644
--- a/lib/cosEventDomain/src/cosEventDomainApp.erl
+++ b/lib/cosEventDomain/src/cosEventDomainApp.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2001-2011. All Rights Reserved.
+%% Copyright Ericsson AB 2001-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -36,9 +36,6 @@
 %%--------------- EXPORTS ------------------------------------
 %% External MISC
 -export([get_option/3, 
-         create_name/2, 
-         create_name/1,
-	 create_id/0,
 	 create_id/1,
          is_debug_compiled/0,
 	 install/0,
@@ -222,31 +219,10 @@ get_option(Key, OptionList, DefaultList) ->
                     {error, "Invalid option"}
             end
     end.
-%%-----------------------------------------------------------%
-%% function : create_name/2
-%% Arguments: 
-%% Returns  : 
-%% Exception: 
-%% Effect   : 
-%%------------------------------------------------------------ 
-create_name(Name,Type) ->
-    {MSec, Sec, USec} = erlang:now(),
-    lists:concat(['oe_',node(),'_',Type,'_',Name,'_',MSec, '_', Sec, '_', USec]).
- 
-%%-----------------------------------------------------------%
-%% function : create_name/1
-%% Arguments: 
-%% Returns  : 
-%% Exception: 
-%% Effect   : 
-%%------------------------------------------------------------
-create_name(Type) ->
-    {MSec, Sec, USec} = erlang:now(),
-    lists:concat(['oe_',node(),'_',Type,'_',MSec, '_', Sec, '_', USec]).
 
 %%------------------------------------------------------------
-%% function : create_id/0
-%% Arguments: - 
+%% function : create_id/1
+%% Arguments: CosEventDomainAdmin::DomainID (long)
 %% Returns  : CosEventDomainAdmin::DomainID (long)
 %% Exception: 
 %% Purpose  : 
@@ -256,10 +232,6 @@ create_id(2147483647) ->
 create_id(OldID) ->
     OldID+1.
 
-
-create_id() ->
-    {_A,_B,C}=now(),
-    C.
 %%------------------------------------------------------------
 %% function : get_qos
 %% Arguments: 
diff --git a/lib/cosFileTransfer/src/cosFileTransferApp.erl b/lib/cosFileTransfer/src/cosFileTransferApp.erl
index 443c917a97..bcc9f485a0 100644
--- a/lib/cosFileTransfer/src/cosFileTransferApp.erl
+++ b/lib/cosFileTransfer/src/cosFileTransferApp.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2000-2009. All Rights Reserved.
+%% Copyright Ericsson AB 2000-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -208,8 +208,9 @@ type_check(Obj, Mod) ->
 %% Effect   : 
 %%------------------------------------------------------------
 create_name(Type) ->
-    {MSec, Sec, USec} = erlang:now(),
-    lists:concat(['oe_',node(),'_',Type,'_',MSec, '_', Sec, '_', USec]).
+    Time = erlang:system_time(),
+    Unique = erlang:unique_integer([positive]),
+    lists:concat(['oe_',node(),'_',Type,'_',Time,'_',Unique]).
 
 
 %%-----------------------------------------------------------%
diff --git a/lib/cosNotification/src/CosNotification_Common.erl b/lib/cosNotification/src/CosNotification_Common.erl
index af9b2d4368..cdaaeee7f8 100644
--- a/lib/cosNotification/src/CosNotification_Common.erl
+++ b/lib/cosNotification/src/CosNotification_Common.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1999-2011. All Rights Reserved.
+%% Copyright Ericsson AB 1999-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -39,8 +39,9 @@
 %%--------------- EXPORTS ------------------------------------
 %% External MISC
 -export([get_option/3, 
-         create_name/2, 
+         create_name/0,
          create_name/1,
+         create_name/2, 
 	 create_id/0,
 	 create_id/1,
          is_debug_compiled/0,
@@ -110,17 +111,20 @@ get_option(Key, OptionList, DefaultList) ->
                     {error, "Invalid option"}
             end
     end.
-%%-----------------------------------------------------------%
-%% function : create_name/2
+
+%%------------------------------------------------------------
+%% function : create_name
 %% Arguments: 
 %% Returns  : 
-%% Exception: 
-%% Effect   : 
+%% Effect   : Create a unique name to use when, for eaxmple, starting
+%%            a new server.
 %%------------------------------------------------------------
-create_name(Name,Type) ->
-    {MSec, Sec, USec} = erlang:now(),
-    lists:concat(['oe_',node(),'_',Type,'_',Name,'_',MSec, '_', Sec, '_', USec]).
- 
+create_name() ->
+    Time = erlang:system_time(),
+    Unique = erlang:unique_integer([positive]),
+    lists:concat(['oe_',node(),'_',Time,'_',Unique]).
+
+
 %%-----------------------------------------------------------%
 %% function : create_name/1
 %% Arguments: 
@@ -129,8 +133,21 @@ create_name(Name,Type) ->
 %% Effect   : 
 %%------------------------------------------------------------ 
 create_name(Type) ->
-    {MSec, Sec, USec} = erlang:now(),
-    lists:concat(['oe_',node(),'_',Type,'_',MSec, '_', Sec, '_', USec]).
+    Time = erlang:system_time(),
+    Unique = erlang:unique_integer([positive]),
+    lists:concat(['oe_',node(),'_',Type,'_',Time,'_',Unique]).
+
+%%-----------------------------------------------------------%
+%% function : create_name/2
+%% Arguments: 
+%% Returns  : 
+%% Exception: 
+%% Effect   : 
+%%------------------------------------------------------------
+create_name(Name,Type) ->
+    Time = erlang:system_time(),
+    Unique = erlang:unique_integer([positive]),
+    lists:concat(['oe_',node(),'_',Type,'_',Name,'_',Time,'_',Unique]).
  
 %%------------------------------------------------------------
 %% function : create_id/0
@@ -146,16 +163,16 @@ create_name(Type) ->
 %%------------------------------------------------------------
 create_id(-1) ->
     1;
-create_id( 2147483647) ->
+create_id(2147483647) ->
     -2147483648;
 create_id(OldID) ->
     OldID+1.
 
 create_id() ->
-    {_A,_B,C}=now(),
+    {_A,_B,C}=erlang:timestamp(),
     C.
  
-%%-----------------------------------------------------------%
+%%------------------------------------------------------------
 %% function : type_check
 %% Arguments: Obj  - objectrefernce to test.
 %%            Mod  - Module which contains typeID/0.
diff --git a/lib/cosNotification/src/CosNotification_Definitions.hrl b/lib/cosNotification/src/CosNotification_Definitions.hrl
index 8325b5aa5e..5db081ec2e 100644
--- a/lib/cosNotification/src/CosNotification_Definitions.hrl
+++ b/lib/cosNotification/src/CosNotification_Definitions.hrl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 1999-2010. All Rights Reserved.
+%% Copyright Ericsson AB 1999-2015. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -315,7 +315,9 @@
 			       {tty, false},
 			       {logfile, false},
 			       {server_options, []}]).
--define(not_CreateDBKey, term_to_binary({now(), node()})).
+-define(not_CreateDBKey, term_to_binary({{erlang:system_time(), 
+					  erlang:unique_integer()}, 
+					node()})).
 
 -define(DEBUG_LEVEL, 3).
 
diff --git a/lib/cosNotification/src/PullerSupplier_impl.erl b/lib/cosNotification/src/PullerSupplier_impl.erl
index 9f12f9c742..22e8355f3a 100644
--- a/lib/cosNotification/src/PullerSupplier_impl.erl
+++ b/lib/cosNotification/src/PullerSupplier_impl.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1999-2009. All Rights Reserved.
+%% Copyright Ericsson AB 1999-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -887,7 +887,7 @@ callAny(_OE_THIS, OE_FROM, State, EventIn, Status) ->
 %% Start timers which send a message each time we should push events. Only used
 %% when this objects is defined to supply sequences.
 start_timer(State) ->
-    TS = now(),
+    TS = erlang:timestamp(),
     case catch timer:send_after(timer:seconds(?get_PacingInterval(State)), 
 				{pacing, TS}) of
 	{ok,PacTRef} ->
diff --git a/lib/cosNotification/src/cosNotificationApp.erl b/lib/cosNotification/src/cosNotificationApp.erl
index ba44163272..251779c558 100644
--- a/lib/cosNotification/src/cosNotificationApp.erl
+++ b/lib/cosNotification/src/cosNotificationApp.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1999-2009. All Rights Reserved.
+%% Copyright Ericsson AB 1999-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -221,7 +221,7 @@ start_global_factory() ->
     
 start_global_factory(Args) when is_list(Args) ->
     SO = 'CosNotification_Common':get_option(server_options, Args, ?not_DEFAULT_SETTINGS),
-    Name = create_name(),
+    Name = 'CosNotification_Common':create_name(),
     SPEC = ['CosNotifyChannelAdmin_EventChannelFactory',Args,
 	    [{sup_child, true}, 
 	     {regname, {global, Name}}|SO]],
@@ -432,16 +432,4 @@ init(app_init) ->
 	    'CosNotifyChannelAdmin_EventChannel_impl']}]}}.
 
 
-
-%%------------------------------------------------------------
-%% function : create_name
-%% Arguments: 
-%% Returns  : 
-%% Effect   : Create a unique name to use when, for eaxmple, starting
-%%            a new server.
-%%------------------------------------------------------------
-create_name() ->
-    {MSec, Sec, USec} = erlang:now(),
-    lists:concat(['oe_',node(),'_',MSec, '_', Sec, '_', USec]).
-
 %%--------------- END OF MODULE ------------------------------
diff --git a/lib/cosNotification/src/cosNotification_eventDB.erl b/lib/cosNotification/src/cosNotification_eventDB.erl
index 89332d53f2..f8e2384d15 100644
--- a/lib/cosNotification/src/cosNotification_eventDB.erl
+++ b/lib/cosNotification/src/cosNotification_eventDB.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2000-2009. All Rights Reserved.
+%% Copyright Ericsson AB 2000-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -71,10 +71,8 @@
 %%   that the first and last Key change place. {K1,K2}<->{K2,K1} and 
 %%   {K1,K2,K3}<->{K3,K2,K1}.
 %%----------------------------------------------------------------------
-
 -module(cosNotification_eventDB).
 
-
 %%--------------- INCLUDES -----------------------------------
 -include_lib("orber/include/corba.hrl").
 -include_lib("orber/include/ifr_types.hrl").
@@ -221,16 +219,16 @@ gc_events(DBRef, _Priority) when ?is_TimeoutNotUsed(DBRef) ->
 gc_events(DBRef, _Priority) when ?is_StopTNotSupported(DBRef) ->
     ok;
 gc_events(DBRef, Priority) ->
-    {M,S,U} = now(),
+    TS = erlang:monotonic_time(),
+    {resolution, TR} = lists:keyfind(resolution, 1, erlang:system_info(os_monotonic_time_source)),
     case get(oe_GC_timestamp) of
-	Num when {M,S,U} > Num ->
-	    put(oe_GC_timestamp, {M,S+?get_GCTime(DBRef),U}),
+	Num when TS > Num ->
+	    put(oe_GC_timestamp, TS + ?get_GCTime(DBRef) * TR),
 	    spawn_link(?MODULE, gc_start, [DBRef, Priority]);
 	_->
 	    ok
     end.
 
-
 %%------------------------------------------------------------
 %% function : gc_start
 %% Arguments: 
@@ -266,13 +264,13 @@ gc_discard_DB({Key1, Key2, Key3}, DRef) ->
 %% Returns  : 
 %%------------------------------------------------------------
 create_FIFO_Key() ->
-    {M, S, U} = erlang:now(),
+    {M, S, U} = erlang:timestamp(), 
     -M*1000000000000 - S*1000000 - U.
 
 %%------------------------------------------------------------
 %% function : convert_FIFO_Key
 %% Arguments: 
-%% Returns  : A now tuple
+%% Returns  : A timestamp tuple
 %% Comment  : Used when we must reuse a timestamp, i.e., only
 %%            when we must reorder the DB.
 %%------------------------------------------------------------
@@ -322,7 +320,7 @@ extract_start_time(#'CosNotification_StructuredEvent'
 	     _ ->
 		 false
 	 end,
-    convert_time(ST, TRef, now());
+    convert_time(ST, TRef, erlang:timestamp());
 extract_start_time(_, _, _) ->
     false.
 
@@ -337,12 +335,12 @@ extract_start_time(_, _, _) ->
 %%             - undefined eq. value needed but no filter associated.
 %%            Now - used when we want to reuse old TimeStamp which
 %%                  must be done when changing QoS.
-%% Returns  : A modified return from now().
+%% Returns  : A modified return from erlang:timestamp().
 %%------------------------------------------------------------
 extract_deadline(_, _, _, _, false) ->
     false;
 extract_deadline(Event, DefaultT, StopTSupported, TRef, MappingVal) ->
-    extract_deadline(Event, DefaultT, StopTSupported, TRef, MappingVal, now()).
+    extract_deadline(Event, DefaultT, StopTSupported, TRef, MappingVal, erlang:timestamp()).
 
 extract_deadline(_, _, _, _, false, _) ->
     false;
@@ -403,14 +401,14 @@ get_time_diff(UTC, TRef) ->
     UB-LB.
 
 check_deadline(DL) when is_tuple(DL) ->
-    {M,S,U}  = now(),
+    {M,S,U}  = erlang:timestamp(),
     DL >= {-M,-S,-U};
 check_deadline(_DL) ->
     %% This case will cover if no timeout is set.
     false.
 
 check_start_time(ST) when is_tuple(ST) ->
-    {M,S,U}  = now(),
+    {M,S,U}  = erlang:timestamp(),
     ST >= {-M,-S,-U};
 check_start_time(_ST) ->
     %% This case will cover if no earliest delivery time is set.
@@ -1139,8 +1137,10 @@ create_db(QoS, GCTime, GCLimit, TimeRef) ->
 	?is_TimeoutNotUsed(DBRef), ?is_StopTNotSupported(DBRef) ->	
 	    ok;
 	true ->
-	    {M,S,U} = now(),
-	    put(oe_GC_timestamp, {M,S+GCTime,U})
+	    TS = erlang:monotonic_time(),
+	    {resolution, TR} = lists:keyfind(resolution, 1, 
+					     erlang:system_info(os_monotonic_time_source)),
+	    put(oe_GC_timestamp, TS+GCTime*TR)
     end,
     DBRef.
 
diff --git a/lib/cosProperty/src/CosPropertyService_PropertySetDef_impl.erl b/lib/cosProperty/src/CosPropertyService_PropertySetDef_impl.erl
index 157b243c53..788518c7bb 100644
--- a/lib/cosProperty/src/CosPropertyService_PropertySetDef_impl.erl
+++ b/lib/cosProperty/src/CosPropertyService_PropertySetDef_impl.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2000-2009. All Rights Reserved.
+%% Copyright Ericsson AB 2000-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -128,7 +128,9 @@
 %%              {stop, Reason}
 %%----------------------------------------------------------------------
 init({DefMode, AllowedTypes, AllowedProperties, InitProperties, MyType}) ->
-    Key = term_to_binary({now(), node()}),
+    Key = term_to_binary({{erlang:system_time(), 
+			   erlang:unique_integer()}, 
+			  node()}),
     _F = ?write_function(#oe_CosPropertyService{key=Key,
 						properties=InitProperties}),
     write_result(mnesia:transaction(_F)),
diff --git a/lib/cosProperty/src/cosProperty.erl b/lib/cosProperty/src/cosProperty.erl
index 2368ee3db6..57c35dedf9 100644
--- a/lib/cosProperty/src/cosProperty.erl
+++ b/lib/cosProperty/src/cosProperty.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2000-2009. All Rights Reserved.
+%% Copyright Ericsson AB 2000-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -406,8 +406,9 @@ type_check(Obj, Mod) ->
 %% Effect   : 
 %%------------------------------------------------------------
 create_name(Type) ->
-    {MSec, Sec, USec} = erlang:now(),
-    lists:concat(['oe_',node(),'_',Type,'_',MSec, '_', Sec, '_', USec]).
+    Time = erlang:system_time(),
+    Unique = erlang:unique_integer([positive]),
+    lists:concat(['oe_',node(),'_',Type,'_',Time,'_',Unique]).
 
 %%--------------- END OF MODULE ------------------------------
 
diff --git a/lib/cosTime/src/CosTime_TimeService_impl.erl b/lib/cosTime/src/CosTime_TimeService_impl.erl
index bac4ae087c..f44e7ba2f4 100644
--- a/lib/cosTime/src/CosTime_TimeService_impl.erl
+++ b/lib/cosTime/src/CosTime_TimeService_impl.erl
@@ -166,7 +166,7 @@ new_interval(_, _, _, _) ->
 create_universal_time() ->
     %% Time is supposed to be #100 nano-secs passed.
     %% We add micro secs for a greater precision.
-    {MS,S,US} = now(),
+    {MS,S,US} = erlang:timestamp(),
     case catch calendar:datetime_to_gregorian_seconds(
 		 calendar:now_to_universal_time({MS,S,US})) of
 	Secs when is_integer(Secs) ->
diff --git a/lib/cosTime/src/cosTime.erl b/lib/cosTime/src/cosTime.erl
index f7d03650af..45f305df39 100644
--- a/lib/cosTime/src/cosTime.erl
+++ b/lib/cosTime/src/cosTime.erl
@@ -333,8 +333,9 @@ type_check(Obj, Mod) ->
 %%------------------------------------------------------------
  
 create_name(Type) ->
-    {MSec, Sec, USec} = erlang:now(),
-    lists:concat(['oe_',node(),'_',Type,'_',MSec, '_', Sec, '_', USec]).
+    Time = erlang:system_time(),
+    Unique = erlang:unique_integer([positive]),
+    lists:concat(['oe_',node(),'_',Type,'_',Time,'_',Unique]).
 
 %%--------------- END OF MODULE ------------------------------
 
diff --git a/lib/cosTime/src/cosTimeApp.hrl b/lib/cosTime/src/cosTimeApp.hrl
index f3082816f7..bdf0bf7278 100644
--- a/lib/cosTime/src/cosTimeApp.hrl
+++ b/lib/cosTime/src/cosTimeApp.hrl
@@ -41,7 +41,7 @@
 -define(max_TimeT, 18446744073709551616).
 
 %% The calendar module uses year 0 as base for gregorian functions.
-%% 'ABSOULTE_TIME_DIFF' is #seconfs from year 0 until 15 october 1582, 00:00.
+%% 'ABSOULTE_TIME_DIFF' is #seconds from year 0 until 15 october 1582, 00:00.
 -define(ABSOLUTE_TIME_DIFF, 49947926400).
 %% As above but diff year 0 to 00:00 GMT, January 1, 1970
 -define(STANDARD_TIME_DIFF, 62167219200).
diff --git a/lib/cosTransactions/src/CosTransactions_TransactionFactory_impl.erl b/lib/cosTransactions/src/CosTransactions_TransactionFactory_impl.erl
index 36e37e2d5f..3954f04ad3 100644
--- a/lib/cosTransactions/src/CosTransactions_TransactionFactory_impl.erl
+++ b/lib/cosTransactions/src/CosTransactions_TransactionFactory_impl.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1999-2009. All Rights Reserved.
+%% Copyright Ericsson AB 1999-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -145,8 +145,8 @@ create(_Self, State, TimeOut) when is_integer(TimeOut) ->
 	_ ->
 	    if
 		TimeOut > 0 ->
-		    {MegaSecs, Secs, _Microsecs} = erlang:now(),
-		    EState2 = ?tr_set_alarm(EState, MegaSecs*1000000+Secs+TimeOut),
+		    TimeStampSec = erlang:monotonic_time(seconds),
+		    EState2 = ?tr_set_alarm(EState, TimeStampSec+TimeOut),
 		    EState3 = ?tr_set_timeout(EState2, TimeOut*1000),
 		    ETraP = ?tr_start_child(?SUP_ETRAP(EState3)),
 		    {reply, ETraP, State};
diff --git a/lib/cosTransactions/src/ETraP_Common.erl b/lib/cosTransactions/src/ETraP_Common.erl
index dd68e9b038..dca1c1aaa9 100644
--- a/lib/cosTransactions/src/ETraP_Common.erl
+++ b/lib/cosTransactions/src/ETraP_Common.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1999-2009. All Rights Reserved.
+%% Copyright Ericsson AB 1999-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -86,8 +86,9 @@ get_option(Key, OptionList, DefaultList) ->
 %%------------------------------------------------------------
  
 create_name(Name,Type) ->
-    {MSec, Sec, USec} = erlang:now(),
-    lists:concat(['oe_',node(),'_',Type,'_',Name,'_',MSec, '_', Sec, '_', USec]).
+    Time = erlang:system_time(),
+    Unique = erlang:unique_integer([positive]),
+    lists:concat(['oe_',node(),'_',Type,'_',Name,'_',Time,'_',Unique]).
  
 %%------------------------------------------------------------
 %% function : create_name/1
@@ -98,8 +99,9 @@ create_name(Name,Type) ->
 %%------------------------------------------------------------
  
 create_name(Type) ->
-    {MSec, Sec, USec} = erlang:now(),
-    lists:concat(['oe_',node(),'_',Type,'_',MSec, '_', Sec, '_', USec]).
+    Time = erlang:system_time(),
+    Unique = erlang:unique_integer([positive]),
+    lists:concat(['oe_',node(),'_',Type,'_',Time,'_',Unique]).
 
 %%------------------------------------------------------------
 %% function : try_timeout
@@ -114,10 +116,9 @@ try_timeout(TimeoutAt) ->
 	infinity ->
 	    false;
 	_->
-	    {MegaSecs, Secs, _Microsecs} = erlang:now(),
-	    Time  =  MegaSecs*1000000+Secs,
+	    TimeSec = erlang:monotonic_time(seconds),
 	    if 
-		Time < TimeoutAt ->
+		TimeSec < TimeoutAt ->
 		    false;
 		true ->
 		    true
diff --git a/lib/cosTransactions/src/ETraP_Server_impl.erl b/lib/cosTransactions/src/ETraP_Server_impl.erl
index e2c5d88f9d..db23d6c166 100644
--- a/lib/cosTransactions/src/ETraP_Server_impl.erl
+++ b/lib/cosTransactions/src/ETraP_Server_impl.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1999-2009. All Rights Reserved.
+%% Copyright Ericsson AB 1999-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -38,7 +38,8 @@
 %% Log files are created in the current directory, which is why the 
 %% application requires read/write rights for current directory. The
 %% file name looks like:
-%% "oe_nonode@nohost_subc_939_383117_295538" (the last part is now())
+%% "oe_nonode@nohost_subc_1429872479809947099_438" (the two last parts are
+%% erlang:system_time() and erlang:unique_integer([positive]))
 %% It is equal to what the object is started as, i.e., {regname, {global, X}}.
 %% 
 %% If the application is unable to read the log it will exit and the 
diff --git a/lib/orber/COSS/CosNaming/CosNaming_NamingContextExt_impl.erl b/lib/orber/COSS/CosNaming/CosNaming_NamingContextExt_impl.erl
index 84db0b89f8..654a8f4385 100644
--- a/lib/orber/COSS/CosNaming/CosNaming_NamingContextExt_impl.erl
+++ b/lib/orber/COSS/CosNaming/CosNaming_NamingContextExt_impl.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2000-2009. All Rights Reserved.
+%% Copyright Ericsson AB 2000-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -533,7 +533,9 @@ unbind(_OE_THIS, _OE_State, []) ->
 %% Returns    : 
 %%----------------------------------------------------------------------
 new_context(_OE_THIS, OE_State) ->
-    DBKey = term_to_binary({now(), node()}),
+    DBKey = term_to_binary({{erlang:system_time(),
+			     erlang:unique_integer()}, 
+			    node()}),
     %% Create a record in the table and set the key to a newly
     {reply, 
      'CosNaming_NamingContextExt':oe_create(DBKey, 
@@ -547,7 +549,9 @@ new_context(_OE_THIS, OE_State) ->
 %% Returns    : 
 %%----------------------------------------------------------------------
 bind_new_context(OE_THIS, OE_State, N) ->
-    DBKey = term_to_binary({now(), node()}),
+    DBKey = term_to_binary({{erlang:system_time(),
+			     erlang:unique_integer()}, 
+			    node()}),
     %% Create a record in the table and set the key to a newly
     %% generated objectkey.
     %%?PRINTDEBUG("bind_new_context"),
diff --git a/lib/orber/src/cdr_decode.erl b/lib/orber/src/cdr_decode.erl
index 9aec64892e..796cc2686b 100644
--- a/lib/orber/src/cdr_decode.erl
+++ b/lib/orber/src/cdr_decode.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1997-2010. All Rights Reserved.
+%% Copyright Ericsson AB 1997-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -1110,8 +1110,7 @@ ifrid_to_name(Id, Type) ->
 				      [?LINE, Id, Type], ?DEBUG_LEVEL),
 			    corba:raise(#'MARSHAL'{completion_status=?COMPLETED_MAYBE});
 			Nodes ->
-			    {A,B,C} = now(),
-			    random:seed(A,B,C),
+			    random:seed(rlang:monotonic_time(), erlang:current_time_offset(), rlang:unique_integer()),
 			    L = length(Nodes),
 			    IFR = get_ifr_node(Nodes, random:uniform(L), L),
 			    list_to_atom('OrberApp_IFR':get_absolute_name(IFR, Id))
@@ -1260,8 +1259,7 @@ get_user_exception_type(TypeId) ->
 						   completion_status=?COMPLETED_MAYBE})
 		    end;
 		Nodes ->
-		    {A,B,C} = now(),
-		    random:seed(A,B,C),
+		    random:seed(rlang:monotonic_time(), erlang:current_time_offset(), rlang:unique_integer()),
 		    L = length(Nodes),
 		    IFR = get_ifr_node(Nodes, random:uniform(L), L),
 		    'OrberApp_IFR':get_user_exception_type(IFR, TypeId)
diff --git a/lib/orber/src/corba.erl b/lib/orber/src/corba.erl
index 586a02d540..f0eeb18c24 100644
--- a/lib/orber/src/corba.erl
+++ b/lib/orber/src/corba.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1997-2011. All Rights Reserved.
+%% Copyright Ericsson AB 1997-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -1922,7 +1922,9 @@ mk_passive_objkey(Mod, Module, Flags) ->
     {Mod, 'passive', Module, term_to_binary(undefined), 0, Flags}.
 
 make_objkey() ->
-    term_to_binary({now(), node()}).
+    term_to_binary({{erlang:system_time(), 
+		     erlang:unique_integer()}, 
+		    node()}).
 
 objkey_to_string({_Mod, 'registered', 'orber_init', _UserDef, _OrberDef, _Flags}) ->
     "INIT";
diff --git a/lib/orber/src/orber_ifr_utils.erl b/lib/orber/src/orber_ifr_utils.erl
index 11e3d1cd3b..35c891ef6e 100644
--- a/lib/orber/src/orber_ifr_utils.erl
+++ b/lib/orber/src/orber_ifr_utils.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1997-2009. All Rights Reserved.
+%% Copyright Ericsson AB 1997-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -289,10 +289,9 @@ makeref(Obj) ->
 %%% unique tag. I do this because the tuple generated takes a lot of space
 %%% when I dump the database. A binary is simply printed as #Bin, which
 %%% is much less obtrusive.
-%%% The code has been moved to a macro defined in orber_ifr.hrl, so we
-%%% can use a simpler uniqification code when debugging.
 
-unique() -> term_to_binary({node(), now()}).
+unique() -> term_to_binary({node(), {erlang:system_time(), 
+				     erlang:unique_integer()}}).
 
 %%%----------------------------------------------------------------------
 %%% Check for an existing object with the Id of the object which is
diff --git a/lib/orber/src/orber_objectkeys.erl b/lib/orber/src/orber_objectkeys.erl
index b0e759187b..f57b1d811f 100644
--- a/lib/orber/src/orber_objectkeys.erl
+++ b/lib/orber/src/orber_objectkeys.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 1997-2009. All Rights Reserved.
+%% Copyright Ericsson AB 1997-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -374,11 +374,11 @@ handle_call({register, Objkey, Pid, Type}, _From, State) ->
 			  %% No key exists. Ok to register.
 			  mnesia:write(#orber_objkeys{object_key=Objkey, pid=Pid,
 						      persistent=Type,
-						      timestamp=now()});
+						      timestamp=erlang:monotonic_time(seconds)});
 		      [X] when X#orber_objkeys.persistent==true,
 			       X#orber_objkeys.pid == dead ->
 			  %% A persistent object is being restarted. Update Pid & time.
-			  mnesia:write(X#orber_objkeys{pid=Pid, timestamp=now()});
+			  mnesia:write(X#orber_objkeys{pid=Pid, timestamp=erlang:monotonic_time(seconds)});
 		      [X] when is_pid(X#orber_objkeys.pid) ->
 			  %% Object exists, i.e., trying to create an object with
 			  %% the same name.
@@ -477,7 +477,7 @@ handle_info({'EXIT', Pid, Reason}, State) when is_pid(Pid) ->
 			       Reason /= normal andalso
 			       Reason /= shutdown ->
 			  mnesia:write(X#orber_objkeys{pid=dead,
-						       timestamp=now()});
+						       timestamp=erlang:monotonic_time(seconds)});
 		      [X] when X#orber_objkeys.persistent==true ->
 			  mnesia:delete({orber_objkeys, X#orber_objkeys.object_key});
 		      _->
@@ -503,8 +503,8 @@ code_change(_OldVsn, State, _Extra) ->
 %% Internal Functions
 %%-----------------------------------------------------------------
 
-timetest(S, {MeSec, Sec, USec}) ->
-    {MeSec, Sec+S, USec} < now().
+timetest(S, TimeStamp) ->
+    TimeStamp+S < erlang:monotonic_time(seconds).
 
 get_key_from_pid(Pid) ->
     case  mnesia:dirty_match_object({orber_objkeys, '_', Pid,'_','_'}) of
diff --git a/lib/orber/src/orber_socket.erl b/lib/orber/src/orber_socket.erl
index 4507d90cce..8ee1611c65 100644
--- a/lib/orber/src/orber_socket.erl
+++ b/lib/orber/src/orber_socket.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 1997-2011. All Rights Reserved.
+%% Copyright Ericsson AB 1997-2015. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -167,8 +167,7 @@ multi_connect([CurrentPort|Rest], Retries, ssl, Host, Port, Options, Timeout) ->
 get_port_sequence(Min, Max) ->
     case orber_env:iiop_out_ports_random() of
 	true ->
-	    {A1,A2,A3} = now(),
-	    random:seed(A1, A2, A3),
+	    random:seed(rlang:monotonic_time(), erlang:current_time_offset(), rlang:unique_integer()),
 	    Seq = lists:seq(Min, Max),
 	    random_sequence((Max - Min) + 1, Seq, []);
 	_ ->
diff --git a/lib/orber/src/orber_web_server.erl b/lib/orber/src/orber_web_server.erl
index 9d2a063a69..1cda862f1b 100644
--- a/lib/orber/src/orber_web_server.erl
+++ b/lib/orber/src/orber_web_server.erl
@@ -2,7 +2,7 @@
 %%
 %% %CopyrightBegin%
 %% 
-%% Copyright Ericsson AB 2001-2009. All Rights Reserved.
+%% Copyright Ericsson AB 2001-2015. All Rights Reserved.
 %% 
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -46,7 +46,7 @@
 
 -define(DEBUG_LEVEL, 5).
 
--record(state, {ts}).
+-record(state, {}).
 -include("ifr_objects.hrl").
 
 %%----------------------------------------------------------------------
@@ -133,9 +133,7 @@ delete_obj(Env, Input) ->
 %% Description: 
 %%----------------------------------------------------------------------
 init(_Arg)->
-    {M, S, U} = now(),
-    TS = M*1000000000000 + S*1000000 + U,
-    {ok, #state{ts = TS}}.
+    {ok, #state{}}.
 
 terminate(_,_State)->
     ok.
-- 
cgit v1.2.3


From 9ca2c2fcc364ee320c61281cf0e89fdd120617c9 Mon Sep 17 00:00:00 2001
From: Lars Thorsen 
Date: Tue, 28 Apr 2015 08:12:05 +0200
Subject: [orber, cos*] Bump versions and update dependencies in app file

---
 lib/cosEvent/src/cosEvent.app.src               | 2 +-
 lib/cosEvent/vsn.mk                             | 3 +--
 lib/cosEventDomain/src/cosEventDomain.app.src   | 2 +-
 lib/cosEventDomain/vsn.mk                       | 3 +--
 lib/cosFileTransfer/src/cosFileTransfer.app.src | 2 +-
 lib/cosFileTransfer/vsn.mk                      | 2 +-
 lib/cosNotification/src/cosNotification.app.src | 2 +-
 lib/cosNotification/vsn.mk                      | 2 +-
 lib/cosProperty/src/cosProperty.app.src         | 2 +-
 lib/cosProperty/vsn.mk                          | 2 +-
 lib/cosTime/src/cosTime.app.src                 | 2 +-
 lib/cosTime/vsn.mk                              | 3 +--
 lib/cosTransactions/src/cosTransactions.app.src | 2 +-
 lib/cosTransactions/vsn.mk                      | 2 +-
 lib/orber/src/orber.app.src                     | 2 +-
 lib/orber/vsn.mk                                | 2 +-
 16 files changed, 16 insertions(+), 19 deletions(-)

(limited to 'lib')

diff --git a/lib/cosEvent/src/cosEvent.app.src b/lib/cosEvent/src/cosEvent.app.src
index 66b0d2e168..5ffd12bc6b 100644
--- a/lib/cosEvent/src/cosEvent.app.src
+++ b/lib/cosEvent/src/cosEvent.app.src
@@ -39,7 +39,7 @@
   {applications, [orber, stdlib, kernel]},
   {env, []},
   {mod, {cosEventApp, []}},
-  {runtime_dependencies, ["stdlib-2.0","orber-3.6.27","kernel-3.0","erts-6.0"]}
+  {runtime_dependencies, ["stdlib-2.0","orber-3.6.27","kernel-3.0","erts-7.0"]}
 ]}.
 
 
diff --git a/lib/cosEvent/vsn.mk b/lib/cosEvent/vsn.mk
index 40bf1ba49d..3149020d7c 100644
--- a/lib/cosEvent/vsn.mk
+++ b/lib/cosEvent/vsn.mk
@@ -1,3 +1,2 @@
-
-COSEVENT_VSN = 2.1.15
+COSEVENT_VSN = 2.2
 
diff --git a/lib/cosEventDomain/src/cosEventDomain.app.src b/lib/cosEventDomain/src/cosEventDomain.app.src
index 60114b6a91..f218ac853e 100644
--- a/lib/cosEventDomain/src/cosEventDomain.app.src
+++ b/lib/cosEventDomain/src/cosEventDomain.app.src
@@ -28,6 +28,6 @@
   {applications, [orber, stdlib, kernel]},
   {env, []},
   {mod, {cosEventDomainApp, []}},
-  {runtime_dependencies, ["stdlib-2.0","orber-3.6.27","kernel-3.0","erts-6.0",
+  {runtime_dependencies, ["stdlib-2.0","orber-3.6.27","kernel-3.0","erts-7.0",
 			  "cosNotification-1.1.21"]}
 ]}.
diff --git a/lib/cosEventDomain/vsn.mk b/lib/cosEventDomain/vsn.mk
index 6317ed3c22..bdde1f6ab2 100644
--- a/lib/cosEventDomain/vsn.mk
+++ b/lib/cosEventDomain/vsn.mk
@@ -1,3 +1,2 @@
-
-COSEVENTDOMAIN_VSN = 1.1.14
+COSEVENTDOMAIN_VSN = 1.2
 
diff --git a/lib/cosFileTransfer/src/cosFileTransfer.app.src b/lib/cosFileTransfer/src/cosFileTransfer.app.src
index 21226b0c6b..033eec9700 100644
--- a/lib/cosFileTransfer/src/cosFileTransfer.app.src
+++ b/lib/cosFileTransfer/src/cosFileTransfer.app.src
@@ -38,6 +38,6 @@
   {env, []},
   {mod, {cosFileTransferApp, []}},
   {runtime_dependencies, ["stdlib-2.0","ssl-5.3.4","orber-3.6.27","kernel-3.0",
-			  "inets-5.10","erts-6.0","cosProperty-1.1.17"]}
+			  "inets-5.10","erts-7.0","cosProperty-1.1.17"]}
 ]}.
 
diff --git a/lib/cosFileTransfer/vsn.mk b/lib/cosFileTransfer/vsn.mk
index f52a1bd800..00bfdb3087 100644
--- a/lib/cosFileTransfer/vsn.mk
+++ b/lib/cosFileTransfer/vsn.mk
@@ -1 +1 @@
-COSFILETRANSFER_VSN = 1.1.16
+COSFILETRANSFER_VSN = 1.2
diff --git a/lib/cosNotification/src/cosNotification.app.src b/lib/cosNotification/src/cosNotification.app.src
index ad02eb4421..09bf8f01fc 100644
--- a/lib/cosNotification/src/cosNotification.app.src
+++ b/lib/cosNotification/src/cosNotification.app.src
@@ -117,6 +117,6 @@
   {applications, [orber, stdlib, kernel]},
   {env, []},
   {mod, {cosNotificationApp, []}},
-  {runtime_dependencies, ["stdlib-2.0","orber-3.6.27","kernel-3.0","erts-6.0",
+  {runtime_dependencies, ["stdlib-2.0","orber-3.6.27","kernel-3.0","erts-7.0",
 			  "cosTime-1.1.14","cosEvent-2.1.15"]}
 ]}.
diff --git a/lib/cosNotification/vsn.mk b/lib/cosNotification/vsn.mk
index 28d6ec71bf..c1affdf0de 100644
--- a/lib/cosNotification/vsn.mk
+++ b/lib/cosNotification/vsn.mk
@@ -1,2 +1,2 @@
-COSNOTIFICATION_VSN = 1.1.21
+COSNOTIFICATION_VSN = 1.2
 
diff --git a/lib/cosProperty/src/cosProperty.app.src b/lib/cosProperty/src/cosProperty.app.src
index b977bb5984..7fad7a602a 100644
--- a/lib/cosProperty/src/cosProperty.app.src
+++ b/lib/cosProperty/src/cosProperty.app.src
@@ -43,5 +43,5 @@
   {env, []},
   {mod, {cosProperty, []}},
   {runtime_dependencies, ["stdlib-2.0","orber-3.6.27","mnesia-4.12",
-			  "kernel-3.0","erts-6.0"]}
+			  "kernel-3.0","erts-7.0"]}
 ]}.
diff --git a/lib/cosProperty/vsn.mk b/lib/cosProperty/vsn.mk
index 0f546a2da8..d96508c2d2 100644
--- a/lib/cosProperty/vsn.mk
+++ b/lib/cosProperty/vsn.mk
@@ -1,2 +1,2 @@
-COSPROPERTY_VSN = 1.1.17
+COSPROPERTY_VSN = 1.2
 
diff --git a/lib/cosTime/src/cosTime.app.src b/lib/cosTime/src/cosTime.app.src
index cd01de35cb..ac71fe1b29 100644
--- a/lib/cosTime/src/cosTime.app.src
+++ b/lib/cosTime/src/cosTime.app.src
@@ -27,6 +27,6 @@
   {applications, [orber, stdlib, kernel]},
   {env, []},
   {mod, {cosTime, []}},
-  {runtime_dependencies, ["stdlib-2.0","orber-3.6.27","kernel-3.0","erts-6.0",
+  {runtime_dependencies, ["stdlib-2.0","orber-3.6.27","kernel-3.0","erts-7.0",
 			  "cosEvent-2.1.15"]}
 ]}.
diff --git a/lib/cosTime/vsn.mk b/lib/cosTime/vsn.mk
index 9e9e5c0250..32416f0087 100644
--- a/lib/cosTime/vsn.mk
+++ b/lib/cosTime/vsn.mk
@@ -1,3 +1,2 @@
-COSTIME_VSN = 1.1.14
-
+COSTIME_VSN = 1.2
 
diff --git a/lib/cosTransactions/src/cosTransactions.app.src b/lib/cosTransactions/src/cosTransactions.app.src
index 6b99915ad6..074d82f487 100644
--- a/lib/cosTransactions/src/cosTransactions.app.src
+++ b/lib/cosTransactions/src/cosTransactions.app.src
@@ -40,5 +40,5 @@
   {applications, [orber, stdlib, kernel]},
   {env, []},
   {mod, {cosTransactions, []}},
-  {runtime_dependencies, ["stdlib-2.0","orber-3.6.27","kernel-3.0","erts-6.0"]}
+  {runtime_dependencies, ["stdlib-2.0","orber-3.6.27","kernel-3.0","erts-7.0"]}
 ]}.
diff --git a/lib/cosTransactions/vsn.mk b/lib/cosTransactions/vsn.mk
index 7aed212523..929f8c73d1 100644
--- a/lib/cosTransactions/vsn.mk
+++ b/lib/cosTransactions/vsn.mk
@@ -1 +1 @@
-COSTRANSACTIONS_VSN = 1.2.14
+COSTRANSACTIONS_VSN = 1.3
diff --git a/lib/orber/src/orber.app.src b/lib/orber/src/orber.app.src
index 30bd90347d..5dda63982f 100644
--- a/lib/orber/src/orber.app.src
+++ b/lib/orber/src/orber.app.src
@@ -105,7 +105,7 @@
   {env, []},
   {mod, {orber, []}},
   {runtime_dependencies, ["stdlib-2.0","ssl-5.3.4","mnesia-4.12","kernel-3.0",
-			  "inets-5.10","erts-6.0"]}
+			  "inets-5.10","erts-7.0"]}
 ]}.
 
 
diff --git a/lib/orber/vsn.mk b/lib/orber/vsn.mk
index 28fe9323fb..505c77de18 100644
--- a/lib/orber/vsn.mk
+++ b/lib/orber/vsn.mk
@@ -1 +1 @@
-ORBER_VSN = 3.7.1
+ORBER_VSN = 3.8
-- 
cgit v1.2.3


From c84295904be29cbcbd3f91d009db91eca94ff158 Mon Sep 17 00:00:00 2001
From: Lars Thorsen 
Date: Wed, 29 Apr 2015 07:13:51 +0200
Subject: [orber] Use rand instead of random

---
 lib/orber/src/cdr_decode.erl   | 8 +++-----
 lib/orber/src/orber_socket.erl | 3 +--
 2 files changed, 4 insertions(+), 7 deletions(-)

(limited to 'lib')

diff --git a/lib/orber/src/cdr_decode.erl b/lib/orber/src/cdr_decode.erl
index 796cc2686b..00dcf01c56 100644
--- a/lib/orber/src/cdr_decode.erl
+++ b/lib/orber/src/cdr_decode.erl
@@ -1110,9 +1110,8 @@ ifrid_to_name(Id, Type) ->
 				      [?LINE, Id, Type], ?DEBUG_LEVEL),
 			    corba:raise(#'MARSHAL'{completion_status=?COMPLETED_MAYBE});
 			Nodes ->
-			    random:seed(rlang:monotonic_time(), erlang:current_time_offset(), rlang:unique_integer()),
 			    L = length(Nodes),
-			    IFR = get_ifr_node(Nodes, random:uniform(L), L),
+			    IFR = get_ifr_node(Nodes, rand:uniform(L), L),
 			    list_to_atom('OrberApp_IFR':get_absolute_name(IFR, Id))
 		    end;
 		{'EXIT', Other} ->
@@ -1175,7 +1174,7 @@ get_ifr_node(Nodes, N, L) ->
 	_ ->
 	    %% Not able to commincate with the node. Try next one.
 	    NewL = L-1,
-	    get_ifr_node(lists:delete(Node, Nodes), random:uniform(NewL), NewL)
+	    get_ifr_node(lists:delete(Node, Nodes), rand:uniform(NewL), NewL)
     end.
 
     
@@ -1259,9 +1258,8 @@ get_user_exception_type(TypeId) ->
 						   completion_status=?COMPLETED_MAYBE})
 		    end;
 		Nodes ->
-		    random:seed(rlang:monotonic_time(), erlang:current_time_offset(), rlang:unique_integer()),
 		    L = length(Nodes),
-		    IFR = get_ifr_node(Nodes, random:uniform(L), L),
+		    IFR = get_ifr_node(Nodes, rand:uniform(L), L),
 		    'OrberApp_IFR':get_user_exception_type(IFR, TypeId)
 	    end
     end.
diff --git a/lib/orber/src/orber_socket.erl b/lib/orber/src/orber_socket.erl
index 8ee1611c65..4567728693 100644
--- a/lib/orber/src/orber_socket.erl
+++ b/lib/orber/src/orber_socket.erl
@@ -167,7 +167,6 @@ multi_connect([CurrentPort|Rest], Retries, ssl, Host, Port, Options, Timeout) ->
 get_port_sequence(Min, Max) ->
     case orber_env:iiop_out_ports_random() of
 	true ->
-	    random:seed(rlang:monotonic_time(), erlang:current_time_offset(), rlang:unique_integer()),
 	    Seq = lists:seq(Min, Max),
 	    random_sequence((Max - Min) + 1, Seq, []);
 	_ ->
@@ -177,7 +176,7 @@ get_port_sequence(Min, Max) ->
 random_sequence(0, _, Acc) ->
     Acc;
 random_sequence(Length, Seq, Acc) ->
-    Nth = random:uniform(Length),
+    Nth = rand:uniform(Length),
     Value = lists:nth(Nth, Seq),
     NewSeq = lists:delete(Value, Seq),
     random_sequence(Length-1, NewSeq, [Value|Acc]).
-- 
cgit v1.2.3


From 2a2d6181184ccde3bc929981eeee662203142238 Mon Sep 17 00:00:00 2001
From: Lars Thorsen 
Date: Wed, 29 Apr 2015 10:13:39 +0200
Subject: [orber, cos*] Remove usage of erlang:now() in test suites

---
 lib/cosFileTransfer/test/fileTransfer_SUITE.erl |  5 +++--
 lib/cosNotification/test/notify_test_impl.erl   |  4 ++--
 lib/orber/test/cdrcoding_10_SUITE.erl           |  4 +++-
 lib/orber/test/cdrcoding_11_SUITE.erl           |  4 +++-
 lib/orber/test/cdrcoding_12_SUITE.erl           |  4 +++-
 lib/orber/test/iop_ior_10_SUITE.erl             |  4 +++-
 lib/orber/test/iop_ior_11_SUITE.erl             |  4 +++-
 lib/orber/test/iop_ior_12_SUITE.erl             |  4 +++-
 lib/orber/test/multi_ORB_SUITE.erl              |  4 ++--
 lib/orber/test/orber_acl_SUITE.erl              | 12 ++++++------
 lib/orber/test/orber_test_lib.erl               |  2 +-
 lib/orber/test/orber_test_server_impl.erl       | 12 ++++++------
 12 files changed, 38 insertions(+), 25 deletions(-)

(limited to 'lib')

diff --git a/lib/cosFileTransfer/test/fileTransfer_SUITE.erl b/lib/cosFileTransfer/test/fileTransfer_SUITE.erl
index dfe6fabfab..5e75a9919f 100644
--- a/lib/cosFileTransfer/test/fileTransfer_SUITE.erl
+++ b/lib/cosFileTransfer/test/fileTransfer_SUITE.erl
@@ -732,8 +732,9 @@ create_file_on_source_node({'NATIVE', _}, _Config, Host, FileName, Path, Data) -
     ?match(ok, file:write_file(FileName, list_to_binary(Data))).
     
 create_name(Type) ->
-    {MSec, Sec, USec} = erlang:now(),
-    lists:concat([Type,'_',MSec, '_', Sec, '_', USec]).
+    Time = erlang:system_time(),
+    Unique = erlang:unique_integer([positive]),
+    lists:concat([Type, '_', Time, '_', Unique]).
 
 
 
diff --git a/lib/cosNotification/test/notify_test_impl.erl b/lib/cosNotification/test/notify_test_impl.erl
index dae7777089..4fe246ef16 100644
--- a/lib/cosNotification/test/notify_test_impl.erl
+++ b/lib/cosNotification/test/notify_test_impl.erl
@@ -289,10 +289,10 @@ disconnect_pull_supplier(_Self, State) ->
 %%--------------- LOCAL FUNCTIONS ----------------------------
 
 delay(Obj, Event, Time, Mod, F) ->
-    io:format("notify_test:delay(~p)  TIME: ~p~n",[Event, now()]),
+    io:format("notify_test:delay(~p)  TIME: ~p~n",[Event, erlang:timestamp()]),
     timer:sleep(Time),
     Mod:F(Obj, Event),
-    io:format("notify_test:delay() DONE: ~p~n",[now()]),
+    io:format("notify_test:delay() DONE: ~p~n",[erlang:timestamp()]),
     ok.
 
 %%--------------- END OF MODULE ------------------------------
diff --git a/lib/orber/test/cdrcoding_10_SUITE.erl b/lib/orber/test/cdrcoding_10_SUITE.erl
index 54ad92cf7e..d8e57f74e5 100644
--- a/lib/orber/test/cdrcoding_10_SUITE.erl
+++ b/lib/orber/test/cdrcoding_10_SUITE.erl
@@ -622,4 +622,6 @@ corba_fake_mk_objkey(Id, 'registered', RegName) when is_atom(RegName) ->
      term_to_binary(undefined), term_to_binary(undefined)}.
 
 make_objkey() ->
-    term_to_binary({now(), node()}).
+    term_to_binary({{erlang:system_time(), 
+		     erlang:unique_integer()}, 
+		    node()}).
diff --git a/lib/orber/test/cdrcoding_11_SUITE.erl b/lib/orber/test/cdrcoding_11_SUITE.erl
index 29b3e33069..bcd2b70446 100644
--- a/lib/orber/test/cdrcoding_11_SUITE.erl
+++ b/lib/orber/test/cdrcoding_11_SUITE.erl
@@ -621,4 +621,6 @@ corba_fake_mk_objkey(Id, 'registered', RegName) when is_atom(RegName) ->
      term_to_binary(undefined), term_to_binary(undefined)}.
 
 make_objkey() ->
-    term_to_binary({now(), node()}).
+    term_to_binary({{erlang:system_time(), 
+		     erlang:unique_integer()}, 
+		    node()}).
diff --git a/lib/orber/test/cdrcoding_12_SUITE.erl b/lib/orber/test/cdrcoding_12_SUITE.erl
index dd9b98434d..a58688b654 100644
--- a/lib/orber/test/cdrcoding_12_SUITE.erl
+++ b/lib/orber/test/cdrcoding_12_SUITE.erl
@@ -609,4 +609,6 @@ corba_fake_mk_objkey(Id, 'registered', RegName) when is_atom(RegName) ->
      term_to_binary(undefined), term_to_binary(undefined)}.
 
 make_objkey() ->
-    term_to_binary({now(), node()}).
+    term_to_binary({{erlang:system_time(), 
+		     erlang:unique_integer()}, 
+		    node()}).
diff --git a/lib/orber/test/iop_ior_10_SUITE.erl b/lib/orber/test/iop_ior_10_SUITE.erl
index 58dd1b5dba..be3daf6198 100644
--- a/lib/orber/test/iop_ior_10_SUITE.erl
+++ b/lib/orber/test/iop_ior_10_SUITE.erl
@@ -182,4 +182,6 @@ corba_fake_mk_objkey(Id, 'registered', RegName) when is_atom(RegName) ->
      
 
 make_objkey() ->
-    term_to_binary({now(), node()}).
+    term_to_binary({{erlang:system_time(), 
+		     erlang:unique_integer()}, 
+		    node()}).
diff --git a/lib/orber/test/iop_ior_11_SUITE.erl b/lib/orber/test/iop_ior_11_SUITE.erl
index 24b2f66357..4c4dd4effa 100644
--- a/lib/orber/test/iop_ior_11_SUITE.erl
+++ b/lib/orber/test/iop_ior_11_SUITE.erl
@@ -201,4 +201,6 @@ corba_fake_mk_objkey(Id, 'registered', RegName) when is_atom(RegName) ->
     {Id, 'registered', RegName, term_to_binary(undefined), 0, 0}.
 
 make_objkey() ->
-    term_to_binary({now(), node()}).
+    term_to_binary({{erlang:system_time(), 
+		     erlang:unique_integer()}, 
+		    node()}).
diff --git a/lib/orber/test/iop_ior_12_SUITE.erl b/lib/orber/test/iop_ior_12_SUITE.erl
index 4c6e9ddb91..9f50784666 100644
--- a/lib/orber/test/iop_ior_12_SUITE.erl
+++ b/lib/orber/test/iop_ior_12_SUITE.erl
@@ -202,4 +202,6 @@ corba_fake_mk_objkey(Id, 'registered', RegName) when is_atom(RegName) ->
     {Id, 'registered', RegName, term_to_binary(undefined), 0, 0}.
 
 make_objkey() ->
-    term_to_binary({now(), node()}).
+    term_to_binary({{erlang:system_time(), 
+		     erlang:unique_integer()}, 
+		    node()}).
diff --git a/lib/orber/test/multi_ORB_SUITE.erl b/lib/orber/test/multi_ORB_SUITE.erl
index 40d8846e0f..3d0132c3e6 100644
--- a/lib/orber/test/multi_ORB_SUITE.erl
+++ b/lib/orber/test/multi_ORB_SUITE.erl
@@ -922,9 +922,9 @@ max_requests(Node, Host, Port) ->
     spawn(orber_test_server, pseudo_call_delay, [Obj, 15000]),
     %% Wait for a second to be sure that the previous request has been sent
     timer:sleep(1000),
-    {MegaSecsB, Before, _} = now(),
+    {MegaSecsB, Before, _} = erlang:timestamp(),
     pseudo_calls(5, Obj),
-    {MegaSecsA, After, _} = now(),
+    {MegaSecsA, After, _} = erlang:timestamp(),
     %% Normally we we can perform hundreds of pseudo-calls per second. Hence,
     %% if we add 8 seconds to 'Before' it should still be less since we only
     %% allow one request at a time to the target ORB.
diff --git a/lib/orber/test/orber_acl_SUITE.erl b/lib/orber/test/orber_acl_SUITE.erl
index ab2c2c872c..05146afded 100644
--- a/lib/orber/test/orber_acl_SUITE.erl
+++ b/lib/orber/test/orber_acl_SUITE.erl
@@ -272,21 +272,21 @@ ipv6_bm(_) ->
 bm2(Filters, Family, Ip) ->
     {ok, IPTuple} = inet:getaddr(Ip, Family),
     orber_acl:init_acl(Filters, Family),
-    TimeBefore1 = erlang:now(),
+    TimeBefore1 = erlang:timestamp(),
     bm_loop(IPTuple, ?NO_OF_TIMES),
-    TimeAfter1 = erlang:now(),
+    TimeAfter1 = erlang:timestamp(),
     orber_acl:clear_acl(),
     Time1 = computeTime(TimeBefore1, TimeAfter1),
     orber_acl:init_acl(Filters, Family),
-    TimeBefore2 = erlang:now(),
+    TimeBefore2 = erlang:timestamp(),
     bm_loop2(Ip, ?NO_OF_TIMES, Family),
-    TimeAfter2 = erlang:now(),
+    TimeAfter2 = erlang:timestamp(),
     orber_acl:clear_acl(),
     Time2 = computeTime(TimeBefore2, TimeAfter2),
     orber_acl:init_acl(Filters, Family),
-    TimeBefore3 = erlang:now(),
+    TimeBefore3 = erlang:timestamp(),
     bm_loop2(IPTuple, ?NO_OF_TIMES, Family),
-    TimeAfter3 = erlang:now(),
+    TimeAfter3 = erlang:timestamp(),
     orber_acl:clear_acl(),
     Time3 = computeTime(TimeBefore3, TimeAfter3),
     {ok, round(?NO_OF_TIMES/Time1), round(?NO_OF_TIMES/Time2), round(?NO_OF_TIMES/Time3)}.
diff --git a/lib/orber/test/orber_test_lib.erl b/lib/orber/test/orber_test_lib.erl
index 46ed26f210..c970600fce 100644
--- a/lib/orber/test/orber_test_lib.erl
+++ b/lib/orber/test/orber_test_lib.erl
@@ -220,7 +220,7 @@ js_node(InitOptions) when is_list(InitOptions) ->
     js_node(InitOptions, []).
 
 js_node(InitOptions, StartOptions) when is_list(InitOptions) ->
-    {A,B,C} = erlang:now(),
+    {A,B,C} = erlang:timestamp(),
     [_, Host] = string:tokens(atom_to_list(node()), [$@]),
     _NewInitOptions = check_options(InitOptions),
     js_node_helper(Host, 0, lists:concat([A,'_',B,'_',C]),
diff --git a/lib/orber/test/orber_test_server_impl.erl b/lib/orber/test/orber_test_server_impl.erl
index 10a9caf242..9aa12e98fb 100644
--- a/lib/orber/test/orber_test_server_impl.erl
+++ b/lib/orber/test/orber_test_server_impl.erl
@@ -243,22 +243,22 @@ relay_cast(_Self, State, Target) ->
 
 %% Testing pseudo calls.
 pseudo_call(_Self, State) ->
-    io:format("orber_test_server:pseudo_call( ~p )~n", [now()]),
+    io:format("orber_test_server:pseudo_call( ~p )~n", [erlang:timestamp()]),
     {reply, ok, State}.
 
 pseudo_cast(_Self, State) ->
-    io:format("orber_test_server:pseudo_cast( ~p )~n", [now()]),
+    io:format("orber_test_server:pseudo_cast( ~p )~n", [erlang:timestamp()]),
     {noreply, State}.
 pseudo_call_delay(_Self, State, Time) ->
-    io:format("orber_test_server:pseudo_call_delay( ~p )~n", [now()]),
+    io:format("orber_test_server:pseudo_call_delay( ~p )~n", [erlang:timestamp()]),
     timer:sleep(Time),
-    io:format("orber_test_server:pseudo_call_delay( ~p )~n", [now()]),
+    io:format("orber_test_server:pseudo_call_delay( ~p )~n", [erlang:timestamp()]),
     {reply, {ok, Time}, State}.
 
 pseudo_cast_delay(_Self, State, Time) ->
-    io:format("orber_test_server:pseudo_cast_delay( ~p )~n", [now()]),
+    io:format("orber_test_server:pseudo_cast_delay( ~p )~n", [erlang:timestamp()]),
     timer:sleep(Time),
-    io:format("orber_test_server:pseudo_cast_delay( ~p )~n", [now()]),
+    io:format("orber_test_server:pseudo_cast_delay( ~p )~n", [erlang:timestamp()]),
     {noreply, State}.
 
 pseudo_call_raise_exc(_Self, State, 1) ->
-- 
cgit v1.2.3


From e44c3bcfea153cfecb5d096be6fad8f830f91198 Mon Sep 17 00:00:00 2001
From: Hans Bolinder 
Date: Thu, 7 May 2015 15:38:08 +0200
Subject: dialyzer: document the type identifier()

---
 lib/hipe/cerl/erl_types.erl | 13 -------------
 1 file changed, 13 deletions(-)

(limited to 'lib')

diff --git a/lib/hipe/cerl/erl_types.erl b/lib/hipe/cerl/erl_types.erl
index 798212d5f9..14335cf635 100644
--- a/lib/hipe/cerl/erl_types.erl
+++ b/lib/hipe/cerl/erl_types.erl
@@ -67,7 +67,6 @@
 	 t_cons/2,
 	 t_cons_hd/1, t_cons_hd/2,
 	 t_cons_tl/1, t_cons_tl/2,
-	 t_constant/0,
          t_contains_opaque/1, t_contains_opaque/2,
          t_decorate_with_opaque/3,
 	 t_elements/1,
@@ -118,7 +117,6 @@
 	 %% t_is_byte/1,
 	 %% t_is_char/1,
 	 t_is_cons/1, t_is_cons/2,
-	 t_is_constant/1,
 	 t_is_equal/2,
 	 t_is_fixnum/1,
 	 t_is_float/1, t_is_float/2,
@@ -1748,17 +1746,6 @@ is_tuple1(_) -> false.
 t_bitstrlist() ->
   t_iolist(1, t_bitstr()).
 
-%% XXX. To be removed.
--spec t_constant() -> erl_type().
-
-t_constant() ->
-  t_sup([t_number(), t_identifier(), t_atom(), t_fun(), t_binary()]).
-
--spec t_is_constant(erl_type()) -> boolean().
-
-t_is_constant(X) ->
-  t_is_subtype(X, t_constant()).
-
 -spec t_arity() -> erl_type().
 
 t_arity() ->
-- 
cgit v1.2.3


From 0124b550307dbc2830669fb113860d90b33b10c4 Mon Sep 17 00:00:00 2001
From: Michael Klishin 
Date: Fri, 27 Mar 2015 04:43:35 +0300
Subject: Fix a typo

---
 lib/kernel/src/heart.erl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib')

diff --git a/lib/kernel/src/heart.erl b/lib/kernel/src/heart.erl
index daed6dd488..77cd5433de 100644
--- a/lib/kernel/src/heart.erl
+++ b/lib/kernel/src/heart.erl
@@ -25,7 +25,7 @@
 %%%--------------------------------------------------------------------
 %%% This is a rewrite of pre_heart from BS.3.
 %%%
-%%% The purpose of this process-module is to act as an supervisor
+%%% The purpose of this process-module is to act as a supervisor
 %%% of the entire erlang-system. This 'heart' beats with a frequence
 %%% satisfying an external port program *not* reboot the entire
 %%% system. If however the erlang-emulator would hang, a reboot is
-- 
cgit v1.2.3


From 9958f2864502385766753f8f4a7d140aa7a582b5 Mon Sep 17 00:00:00 2001
From: Derek Brown 
Date: Sun, 5 Apr 2015 20:19:35 -0400
Subject: Add mention of ?assertNotMatch and ?assertNotEqual

These two macros are defined in eunit.hrl, but are missing in this
documentation.
---
 lib/eunit/doc/overview.edoc | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'lib')

diff --git a/lib/eunit/doc/overview.edoc b/lib/eunit/doc/overview.edoc
index 872a017440..df716cdeea 100644
--- a/lib/eunit/doc/overview.edoc
+++ b/lib/eunit/doc/overview.edoc
@@ -569,6 +569,9 @@ Examples:
 ```?assertMatch({found, {fred, _}}, lookup(bloggs, Table))'''
 ```?assertMatch([X|_] when X > 0, binary_to_list(B))'''
 
+
`assertNotMatch(GuardedPattern, Expr)'

+
The inverse case of assertMatch, for convenience.
+

 
`assertEqual(Expect, Expr)'

 
Evaluates the expressions `Expect' and `Expr' and compares the
 results for equality, if testing is enabled. If the values are not
@@ -583,6 +586,9 @@ Examples:
 ```?assertEqual("b" ++ "a", lists:reverse("ab"))'''
 ```?assertEqual(foo(X), bar(Y))'''
 

+
`assertNotEqual(Unexpected, Expr)'

+
The inverse case of assertEqual, for convenience.
+

 
`assertException(ClassPattern, TermPattern, Expr)'

 
`assertError(TermPattern, Expr)'

 
`assertExit(TermPattern, Expr)'

-- 
cgit v1.2.3


From fd8d054c22a5ee81015d5e0add297ba7144a0840 Mon Sep 17 00:00:00 2001
From: Hans Bolinder 
Date: Fri, 8 May 2015 12:28:25 +0200
Subject: typer: Properly extract annotations

The addition of the erl_anno module, OTP-12195, also modified v3_core
so that functions with line number zero are regarded as compiler
generated.
---
 lib/typer/src/typer.erl | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

(limited to 'lib')

diff --git a/lib/typer/src/typer.erl b/lib/typer/src/typer.erl
index cbad05081e..f8070e04c1 100644
--- a/lib/typer/src/typer.erl
+++ b/lib/typer/src/typer.erl
@@ -2,7 +2,7 @@
 %%-----------------------------------------------------------------------
 %% %CopyrightBegin%
 %%
-%% Copyright Ericsson AB 2006-2014. All Rights Reserved.
+%% Copyright Ericsson AB 2006-2015. All Rights Reserved.
 %%
 %% The contents of this file are subject to the Erlang Public License,
 %% Version 1.1, (the "License"); you may not use this file except in
@@ -931,7 +931,9 @@ analyze_one_function({Var, FunBody} = Function, Acc) ->
   A = cerl:fname_arity(Var),
   TmpDialyzerObj = {{Acc#tmpAcc.module, F, A}, Function},
   NewDialyzerObj = Acc#tmpAcc.dialyzerObj ++ [TmpDialyzerObj],  
-  [_, LineNo, {file, FileName}] = cerl:get_ann(FunBody),
+  Anno = cerl:get_ann(FunBody),
+  LineNo = get_line(Anno),
+  FileName = get_file(Anno),
   BaseName = filename:basename(FileName),
   FuncInfo = {LineNo, F, A},
   OriginalName = Acc#tmpAcc.file,
@@ -951,6 +953,14 @@ analyze_one_function({Var, FunBody} = Function, Acc) ->
 	     incFuncAcc = IncFuncAcc,
 	     dialyzerObj = NewDialyzerObj}.
 
+get_line([Line|_]) when is_integer(Line) -> Line;
+get_line([_|T]) -> get_line(T);
+get_line([]) -> none.
+
+get_file([{file,File}|_]) -> File;
+get_file([_|T]) -> get_file(T);
+get_file([]) -> "no_file". % should not happen
+
 -spec get_dialyzer_plt(analysis()) -> plt().
 
 get_dialyzer_plt(#analysis{plt = PltFile0}) ->
-- 
cgit v1.2.3


From 9b2988b5409dbd629ce57bf89fa1c3bad69b2a42 Mon Sep 17 00:00:00 2001
From: Andras Horvath 
Date: Tue, 7 Apr 2015 13:23:10 +0100
Subject: Delete superfluous comma from `filtermap' example

The code explaining the behaviour of `filtermap/2` had a syntax error and wouldn't compile
---
 lib/stdlib/doc/src/lists.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib')

diff --git a/lib/stdlib/doc/src/lists.xml b/lib/stdlib/doc/src/lists.xml
index ee3c51c62c..dcc08d008b 100644
--- a/lib/stdlib/doc/src/lists.xml
+++ b/lib/stdlib/doc/src/lists.xml
@@ -176,7 +176,7 @@ filtermap(Fun, List1) ->
                            false -> Acc;
                            true -> [Elem|Acc];
                            {true,Value} -> [Value|Acc]
-                       end,
+                       end
                 end, [], List1).
         
Example:

         
-- 
cgit v1.2.3


From 5c192ac2faf510c24a4f9c9936dd580d5d304183 Mon Sep 17 00:00:00 2001
From: Bruce Yinhe 
Date: Fri, 20 Mar 2015 15:25:00 +0100
Subject: Fixed a typo in Maps doc

---
 lib/stdlib/doc/src/maps.xml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib')

diff --git a/lib/stdlib/doc/src/maps.xml b/lib/stdlib/doc/src/maps.xml
index 59c26d9896..e46068230a 100644
--- a/lib/stdlib/doc/src/maps.xml
+++ b/lib/stdlib/doc/src/maps.xml
@@ -339,7 +339,7 @@ false
 			
 			
 				

-					Returns a complete list of values, in arbitrary order, contained in map M.
+					Returns a complete list of values, in arbitrary order, contained in map Map.
 				

 				

 					The call will fail with a {badmap,Map} exception if Map is not a map.
-- 
cgit v1.2.3


From 0ca698b01fc2f90cf7a14995cb76ccf8e26a9913 Mon Sep 17 00:00:00 2001
From: David Kubecka 
Date: Sun, 5 Apr 2015 13:29:28 +0200
Subject: digraph: export label type

Together with vertex and edge, label is a core type of digraph module
according to documentation and therefore should be exported as well.
---
 lib/stdlib/src/digraph.erl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib')

diff --git a/lib/stdlib/src/digraph.erl b/lib/stdlib/src/digraph.erl
index 0c21271529..1f8caa88a4 100644
--- a/lib/stdlib/src/digraph.erl
+++ b/lib/stdlib/src/digraph.erl
@@ -36,7 +36,7 @@
 
 -export([get_short_path/3, get_short_cycle/2]).
 
--export_type([graph/0, d_type/0, vertex/0, edge/0]).
+-export_type([graph/0, d_type/0, vertex/0, edge/0, label/0]).
 
 -record(digraph, {vtab = notable :: ets:tab(),
 		  etab = notable :: ets:tab(),
-- 
cgit v1.2.3


From 1dbb97809d0d4cafab45cf0f0281f88ed777cae3 Mon Sep 17 00:00:00 2001
From: Hans Nilsson 
Date: Fri, 8 May 2015 15:39:38 +0200
Subject: ssh: Check e and f parameters in kexdh

rfc 4253 says in section 8 that:
   "Values of 'e' or 'f' that are not in the range [1, p-1] MUST NOT be
     sent or accepted by either side.  If this condition is violated, the
     key exchange fails."

This commit implements the reception check.
---
 lib/ssh/src/ssh_transport.erl | 50 +++++++++++++++++++++++++++++--------------
 1 file changed, 34 insertions(+), 16 deletions(-)

(limited to 'lib')

diff --git a/lib/ssh/src/ssh_transport.erl b/lib/ssh/src/ssh_transport.erl
index 8669be570e..d6414bab6c 100644
--- a/lib/ssh/src/ssh_transport.erl
+++ b/lib/ssh/src/ssh_transport.erl
@@ -240,20 +240,30 @@ key_exchange_first_msg('diffie-hellman-group-exchange-sha1', Ssh0) ->
 
 handle_kexdh_init(#ssh_msg_kexdh_init{e = E}, Ssh0) ->
     {G, P} = dh_group1(),
-    {Private, Public} = dh_gen_key(G, P, 1024),
-    K = ssh_math:ipow(E, Private, P),
-    Key = get_host_key(Ssh0),
-    H = kex_h(Ssh0, Key, E, Public, K),
-    H_SIG = sign_host_key(Ssh0, Key, H),
-    {SshPacket, Ssh1} = ssh_packet(#ssh_msg_kexdh_reply{public_host_key = Key,
-							f = Public,
-							h_sig = H_SIG
-						       }, Ssh0),
-
-    {ok, SshPacket, Ssh1#ssh{keyex_key = {{Private, Public}, {G, P}},
-			     shared_secret = K,
-			     exchanged_hash = H,
-			     session_id = sid(Ssh1, H)}}.
+    if
+	1=
+	    {Private, Public} = dh_gen_key(G, P, 1024),
+	    K = ssh_math:ipow(E, Private, P),
+	    Key = get_host_key(Ssh0),
+	    H = kex_h(Ssh0, Key, E, Public, K),
+	    H_SIG = sign_host_key(Ssh0, Key, H),
+	    {SshPacket, Ssh1} = ssh_packet(#ssh_msg_kexdh_reply{public_host_key = Key,
+								f = Public,
+								h_sig = H_SIG
+							       }, Ssh0),
+	    
+	    {ok, SshPacket, Ssh1#ssh{keyex_key = {{Private, Public}, {G, P}},
+				     shared_secret = K,
+				     exchanged_hash = H,
+				     session_id = sid(Ssh1, H)}};
+	true ->
+	    Error = {error,bad_e_from_peer},
+	    Disconnect = #ssh_msg_disconnect{
+			    code = ?SSH_DISCONNECT_KEY_EXCHANGE_FAILED,
+			    description = "Key exchange failed, 'f' out of bounds",
+			    language = "en"},
+	    throw({Error, Disconnect})
+    end.
 
 handle_kex_dh_gex_group(#ssh_msg_kex_dh_gex_group{p = P, g = G}, Ssh0) ->
     {Private, Public} = dh_gen_key(G,P,1024),
@@ -277,7 +287,7 @@ handle_new_keys(#ssh_msg_newkeys{}, Ssh0) ->
 %% %% Select algorithms
 handle_kexdh_reply(#ssh_msg_kexdh_reply{public_host_key = HostKey, f = F,
 					h_sig = H_SIG}, 
-		   #ssh{keyex_key = {{Private, Public}, {_G, P}}} = Ssh0) ->
+		   #ssh{keyex_key = {{Private, Public}, {_G, P}}} = Ssh0) when 1=
     K = ssh_math:ipow(F, Private, P),
     H = kex_h(Ssh0, HostKey, Public, F, K),
 
@@ -293,7 +303,15 @@ handle_kexdh_reply(#ssh_msg_kexdh_reply{public_host_key = HostKey, f = F,
 	      description = "Key exchange failed",
 	      language = "en"},
 	    throw({Error, Disconnect})
-    end.
+    end;
+handle_kexdh_reply(#ssh_msg_kexdh_reply{}, _SSH) ->
+    Error = {error,bad_f_from_peer},
+    Disconnect = #ssh_msg_disconnect{
+		    code = ?SSH_DISCONNECT_KEY_EXCHANGE_FAILED,
+		    description = "Key exchange failed, 'f' out of bounds",
+		    language = "en"},
+    throw({Error, Disconnect}).
+
 
 handle_kex_dh_gex_request(#ssh_msg_kex_dh_gex_request{min = _Min,
 						      n   = _NBits,
-- 
cgit v1.2.3


From 603ffe32e1947e2c9550eabe15c477c343cbaba1 Mon Sep 17 00:00:00 2001
From: Peter Andersson 
Date: Fri, 8 May 2015 17:50:59 +0200
Subject: Update version numbers and app dependencies

---
 lib/common_test/src/common_test.app.src | 11 ++++++-----
 lib/common_test/vsn.mk                  |  2 +-
 lib/test_server/src/test_server.app.src |  6 +++---
 lib/test_server/vsn.mk                  |  2 +-
 4 files changed, 11 insertions(+), 10 deletions(-)

(limited to 'lib')

diff --git a/lib/common_test/src/common_test.app.src b/lib/common_test/src/common_test.app.src
index 580d5dbd7b..0be1466fc9 100644
--- a/lib/common_test/src/common_test.app.src
+++ b/lib/common_test/src/common_test.app.src
@@ -63,9 +63,10 @@
 		ct_master_logs]},
   {applications, [kernel,stdlib]},
   {env, []},
-  {runtime_dependencies,["xmerl-1.3.7","webtool-0.8.10","tools-2.6.14",
-			 "test_server-3.7.1","stdlib-2.0","ssh-3.0.1",
-			 "snmp-4.25.1","sasl-2.4","runtime_tools-1.8.14",
-			 "kernel-3.0","inets-5.10","erts-6.0",
-			 "debugger-4.0","crypto-3.3","compiler-5.0"]}]}.
+  {runtime_dependencies,["xmerl-1.3.8","tools-2.8",
+			 "test_server-3.9","stdlib-2.5","ssh-4.0",
+			 "snmp-5.1.2","sasl-2.4.2","runtime_tools-1.8.16",
+			 "kernel-4.0","inets-6.0","erts-7.0",
+			 "debugger-4.1","crypto-3.6","compiler-6.0",
+			 "observer-2.1"]}]}.
 
diff --git a/lib/common_test/vsn.mk b/lib/common_test/vsn.mk
index e2d921729c..ff2bd20ab3 100644
--- a/lib/common_test/vsn.mk
+++ b/lib/common_test/vsn.mk
@@ -1 +1 @@
-COMMON_TEST_VSN = 1.10.1
+COMMON_TEST_VSN = 1.11
diff --git a/lib/test_server/src/test_server.app.src b/lib/test_server/src/test_server.app.src
index 5538e8b851..bdd9d28444 100644
--- a/lib/test_server/src/test_server.app.src
+++ b/lib/test_server/src/test_server.app.src
@@ -32,7 +32,7 @@
 		test_server_break_process]},
   {applications, [kernel,stdlib]},
   {env, []},
-  {runtime_dependencies, ["tools-2.6.14","stdlib-2.0","runtime_tools-1.8.14",
-			  "observer-2.0","kernel-3.0","inets-5.10",
-			  "syntax_tools-1.6.16","erts-7.0"]}]}.
+  {runtime_dependencies, ["tools-2.8","stdlib-2.5","runtime_tools-1.8.16",
+			  "observer-2.1","kernel-4.0","inets-6.0",
+			  "syntax_tools-1.7","erts-7.0"]}]}.
   
diff --git a/lib/test_server/vsn.mk b/lib/test_server/vsn.mk
index 2a2ed2b3b0..fd9e4e6d74 100644
--- a/lib/test_server/vsn.mk
+++ b/lib/test_server/vsn.mk
@@ -1 +1 @@
-TEST_SERVER_VSN = 3.8.1
+TEST_SERVER_VSN = 3.9
-- 
cgit v1.2.3


From 7a671f9cc3b0db983cb368eaefc12f148aefb542 Mon Sep 17 00:00:00 2001
From: Peter Andersson 
Date: Sat, 9 May 2015 00:29:50 +0200
Subject: Fix remaining issues in source code parser

---
 lib/test_server/src/erl2html2.erl | 30 ++++++++++++++----------------
 1 file changed, 14 insertions(+), 16 deletions(-)

(limited to 'lib')

diff --git a/lib/test_server/src/erl2html2.erl b/lib/test_server/src/erl2html2.erl
index 2e443c7b8b..9101212852 100644
--- a/lib/test_server/src/erl2html2.erl
+++ b/lib/test_server/src/erl2html2.erl
@@ -109,27 +109,26 @@ parse_file(File, InclPath) ->
 	    Error
     end.
 
-parse_preprocessed_file(Epp,File,InCorrectFile) ->
+parse_preprocessed_file(Epp, File, InCorrectFile) ->
     case epp:parse_erl_form(Epp) of
 	{ok,Form} ->
 	    case Form of
 		{attribute,_,file,{File,_}} ->
-		    parse_preprocessed_file(Epp,File,true);
+		    parse_preprocessed_file(Epp, File, true);
 		{attribute,_,file,{_OtherFile,_}} ->
-		    parse_preprocessed_file(Epp,File,false);
+		    parse_preprocessed_file(Epp, File, false);
                 {function,L,F,A,Cs} when InCorrectFile ->
                     {CLs,LastCL} = find_clause_lines(Cs, []),
-		    Clauses = [{clause,get_line(CL)} ||
-                                  {clause,CL,_,_,_} <- tl(CLs)],
-		    [{atom_to_list(F),A,get_line(L),get_line(LastCL)} | Clauses] ++
-			parse_preprocessed_file(Epp,File,true);
+		    %% tl(CLs) cause we know the start line already
+		    [{atom_to_list(F),A,get_line(L),LastCL} | tl(CLs)] ++
+			parse_preprocessed_file(Epp, File, true);
 		_ ->
-		    parse_preprocessed_file(Epp,File,InCorrectFile)
+		    parse_preprocessed_file(Epp, File, InCorrectFile)
 	    end;
 	{error,Reason={_L,epp,{undefined,_Macro,none}}} ->
 	    throw({error,Reason,InCorrectFile});
 	{error,_Reason} ->
-	    parse_preprocessed_file(Epp,File,InCorrectFile);
+	    parse_preprocessed_file(Epp, File, InCorrectFile);
 	{eof,_Location} ->
 	    []
     end.
@@ -150,9 +149,8 @@ parse_non_preprocessed_file(Epp, File, Location) ->
 	    try erl_syntax:revert(Tree) of
                 {function,L,F,A,Cs} ->
                     {CLs,LastCL} = find_clause_lines(Cs, []),
-                    Clauses = [{clause,get_line(CL)} ||
-                                  {clause,CL,_,_,_} <- tl(CLs)],
-                    [{atom_to_list(F),A,get_line(L),get_line(LastCL)} | Clauses] ++
+		    %% tl(CLs) cause we know the start line already
+                    [{atom_to_list(F),A,get_line(L),LastCL} | tl(CLs)] ++
 			parse_non_preprocessed_file(Epp, File, Location1);
 		_ ->
 		    parse_non_preprocessed_file(Epp, File, Location1)
@@ -173,16 +171,16 @@ get_line(Anno) ->
 find_clause_lines([{clause,CL,_Params,_Op,Exprs}], CLs) -> % last clause
     try tuple_to_list(lists:last(Exprs)) of
 	[_Type,ExprLine | _] ->
-	    {lists:reverse([{clause,CL}|CLs]), ExprLine};
+	    {lists:reverse([{clause,get_line(CL)}|CLs]), get_line(ExprLine)};
 	_ ->
-	    {lists:reverse([{clause,CL}|CLs]), CL}
+	    {lists:reverse([{clause,get_line(CL)}|CLs]), get_line(CL)}
     catch
 	_:_ ->
-	    {lists:reverse([{clause,CL}|CLs]), CL}
+	    {lists:reverse([{clause,get_line(CL)}|CLs]), get_line(CL)}
     end;
 
 find_clause_lines([{clause,CL,_Params,_Op,_Exprs} | Cs], CLs) ->
-    find_clause_lines(Cs, [{clause,CL}|CLs]).
+    find_clause_lines(Cs, [{clause,get_line(CL)}|CLs]).
 
 %%%-----------------------------------------------------------------
 %%% Add a link target for each line and one for each function definition.
-- 
cgit v1.2.3


From 493772276f90e2a880cdc1e0091848a7088d247f Mon Sep 17 00:00:00 2001
From: Peter Andersson 
Date: Sat, 9 May 2015 02:02:14 +0200
Subject: Fix problem with OTP benchmark tests failing to run

---
 lib/test_server/src/ts.erl | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

(limited to 'lib')

diff --git a/lib/test_server/src/ts.erl b/lib/test_server/src/ts.erl
index 469593e947..85f97656ff 100644
--- a/lib/test_server/src/ts.erl
+++ b/lib/test_server/src/ts.erl
@@ -262,18 +262,28 @@ run_all(_Vars) ->
 
 run_some([], _Opts) ->
     ok;
-run_some([{App,Mod}|Apps], Opts) ->
+run_some(Apps, Opts) ->
+    case proplists:get_value(test_category, Opts) of
+	bench ->
+	    check_and_run(fun(Vars) -> ts_benchmark:run(Apps, Opts, Vars) end);
+	_Other ->
+	    run_some1(Apps, Opts)
+    end.
+
+run_some1([], _Opts) ->
+    ok;
+run_some1([{App,Mod}|Apps], Opts) ->
     case run(App, Mod, Opts) of
 	ok -> ok;
 	Error -> io:format("~p: ~p~n",[{App,Mod},Error])
     end,
-    run_some(Apps, Opts);
-run_some([App|Apps], Opts) ->
+    run_some1(Apps, Opts);
+run_some1([App|Apps], Opts) ->
     case run(App, Opts) of
 	ok -> ok;
 	Error -> io:format("~p: ~p~n",[App,Error])
     end,
-    run_some(Apps, Opts).
+    run_some1(Apps, Opts).
 
 %% This can be used from command line. Both App and
 %% TestCategory must be specified. App may be 'all'
-- 
cgit v1.2.3


From 42d25222fa7395ad9fb58de2c964afa4caefb5b1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jos=C3=A9=20Valim?= 
Date: Fri, 9 May 2014 18:07:07 +0200
Subject: Send format and args on process exit to error_logger

Previously, the emulator would generate a whole string
with values and call the error_logger passing "~s~n".
This commit changes it to a format string containing ~p
with the respective values as arguments.
---
 lib/kernel/test/error_logger_SUITE.erl | 22 ++++++++--------------
 1 file changed, 8 insertions(+), 14 deletions(-)

(limited to 'lib')

diff --git a/lib/kernel/test/error_logger_SUITE.erl b/lib/kernel/test/error_logger_SUITE.erl
index 05bf5aae18..1c2e56f083 100644
--- a/lib/kernel/test/error_logger_SUITE.erl
+++ b/lib/kernel/test/error_logger_SUITE.erl
@@ -32,7 +32,7 @@
 	 error_report/1, info_report/1, error/1, info/1,
 	 emulator/1, tty/1, logfile/1, add/1, delete/1]).
 
--export([generate_error/0]).
+-export([generate_error/2]).
 
 -export([init/1,
 	 handle_event/2, handle_call/2, handle_info/2,
@@ -210,13 +210,16 @@ emulator(suite) -> [];
 emulator(doc) -> [];
 emulator(Config) when is_list(Config) ->
     ?line error_logger:add_report_handler(?MODULE, self()),
-    spawn(?MODULE, generate_error, []),
-    reported(emulator),
+    Msg = "Error in process ~p on node ~p with exit value:~n~p~n",
+    Error = {badmatch,4},
+    Stack = [{module, function, 2, []}],
+    Pid = spawn(?MODULE, generate_error, [Error, Stack]),
+    reported(error, Msg, [Pid, node(), {Error, Stack}]),
     ?line my_yes = error_logger:delete_report_handler(?MODULE),
     ok.
 
-generate_error() ->
-    erlang:error({badmatch,4}).
+generate_error(Error, Stack) ->
+    erlang:raise(error, Error, Stack).
 
 %%-----------------------------------------------------------------
 %% We don't enables or disables tty error logging here. We do not
@@ -283,15 +286,6 @@ reported(Tag, Type, Report) ->
 	    test_server:fail(no_report_received)
     end.
 
-reported(emulator) ->
-    receive
-	{error, "~s~n", String} when is_list(String) ->
-	    test_server:messages_get(),
-	    ok
-    after 1000 ->
-	    test_server:fail(no_report_received)
-    end.
-
 %%-----------------------------------------------------------------
 %% The error_logger handler (gen_event behaviour).
 %% Sends a notification to the Tester process about the events
-- 
cgit v1.2.3


From 0f2d15c95f98e7b271111c9311210a808c624adb Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin 
Date: Fri, 8 May 2015 15:57:15 +0200
Subject: public_key, ssl: Align public_key and ssl doc

Make sure that links from ssl to public_key work.

OTP-12670 - Ignoring 1.2 extension in 1.0 or TLS-1.1
solved by 5edda23ee854038c9d4bcddd0d676ee0ffd20da5
is mentioned here to make the release scripts happy,
as the branch solving this accidently had a name ending 1267
instead of 12670
---
 lib/public_key/doc/src/Makefile               |   2 +-
 lib/public_key/doc/src/part.xml               |   2 +-
 lib/public_key/doc/src/public_key_records.xml | 841 ++++++++++++++++++++++++++
 lib/public_key/doc/src/records.xml            | 841 --------------------------
 lib/ssl/doc/src/ssl.xml                       |   8 +-
 lib/ssl/doc/src/ssl_crl_cache_api.xml         |   4 +-
 6 files changed, 849 insertions(+), 849 deletions(-)
 create mode 100644 lib/public_key/doc/src/public_key_records.xml
 delete mode 100644 lib/public_key/doc/src/records.xml

(limited to 'lib')

diff --git a/lib/public_key/doc/src/Makefile b/lib/public_key/doc/src/Makefile
index 2adc13a5cf..d04819b5aa 100644
--- a/lib/public_key/doc/src/Makefile
+++ b/lib/public_key/doc/src/Makefile
@@ -42,7 +42,7 @@ XML_REF6_FILES =
 XML_PART_FILES = part.xml part_notes.xml
 XML_CHAPTER_FILES = \
 	introduction.xml \
-        records.xml \
+        public_key_records.xml \
 	using_public_key.xml \
 	notes.xml
 
diff --git a/lib/public_key/doc/src/part.xml b/lib/public_key/doc/src/part.xml
index d3cc9303bd..465f311946 100644
--- a/lib/public_key/doc/src/part.xml
+++ b/lib/public_key/doc/src/part.xml
@@ -38,7 +38,7 @@
     PKCS standard.

   
   
-  
+  
   
 
 
diff --git a/lib/public_key/doc/src/public_key_records.xml b/lib/public_key/doc/src/public_key_records.xml
new file mode 100644
index 0000000000..9536167839
--- /dev/null
+++ b/lib/public_key/doc/src/public_key_records.xml
@@ -0,0 +1,841 @@
+
+
+
+
+  

+    
+      2008
+      2015
+      Ericsson AB, All Rights Reserved
+    
+    
+  The contents of this file are subject to the Erlang Public License,
+  Version 1.1, (the "License"); you may not use this file except in
+  compliance with the License. You should have received a copy of the
+  Erlang Public License along with this software. If not, it can be
+  retrieved online at http://www.erlang.org/.
+
+  Software distributed under the License is distributed on an "AS IS"
+  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+  the License for the specific language governing rights and limitations
+  under the License.
+
+  The Initial Developer of the Original Code is Ericsson AB.
+    
+
+    Public-Key Records
+    Ingela Anderton Andin
+    
+    
+    
+    
+    2008-02-06
+    A
+    public_key_records.xml
+  

+    
+  
This chapter briefly describes Erlang records derived from ASN.1
+  specifications used to handle public key infrastructure.
+  The scope is to describe the data types of each component,
+  not the semantics. For information on the
+  semantics, refer to the relevant standards and RFCs linked in the sections below.

+
+  
Use the following include directive to get access to the
+  records and constant macros described in the following sections:

+  
+   -include_lib("public_key/include/public_key.hrl"). 
+
+ 

+    Data Types   
+
+    
Common non-standard Erlang
+    data types used to describe the record fields in the
+    following sections and which are not defined in the Public Key Reference Manual
+    follows here:

+    
+    
+      time()
+      
= uct_time() | general_time()

+
+      uct_time()
+      
= {utcTime, "YYMMDDHHMMSSZ"}

+
+      general_time()
+      
= {generalTime, "YYYYMMDDHHMMSSZ"}

+ 
+      general_name()
+      = 
{rfc822Name, string()}

+      
| {dNSName, string()}

+      
| {x400Address, string()}

+      
| {directoryName, {rdnSequence, [#AttributeTypeAndValue'{}]}}

+      
| {eidPartyName, special_string()}

+      
| {eidPartyName, special_string(), special_string()}

+      
| {uniformResourceIdentifier, string()}

+      
| {ipAddress, string()}

+      
| {registeredId, oid()}

+      
| {otherName, term()}

+      
+
+      special_string()
+      = 
{teletexString, string()}

+      
| {printableString, string()}

+      
| {universalString, string()}

+      
| {utf8String, binary()}

+      
| {bmpString, string()}

+      
+
+      dist_reason()
+      = 
unused

+      
| keyCompromise

+      
| cACompromise

+      
| affiliationChanged

+      
| superseded

+      
| cessationOfOperation

+      
| certificateHold

+      
| privilegeWithdrawn

+      
| aACompromise

+      
+
+      OID_macro()
+      = 
?OID_name() 

+      
+      
+      OID_name()
+      = 
atom()

+      
+      
+    
+
+  

+  
+  

+    RSA
+    
Erlang representation of  
+    Rivest-Shamir-Adleman cryptosystem (RSA) keys follows:

+    
+    
+#'RSAPublicKey'{
+	  modulus,       % integer()
+	  publicExponent % integer()
+	  }.
+
+#'RSAPrivateKey'{
+          version,         % two-prime | multi
+	  modulus,         % integer()
+	  publicExponent,  % integer()
+	  privateExponent, % integer()
+	  prime1,          % integer() 
+	  prime2,          % integer()
+	  exponent1,       % integer()
+	  exponent2,       % integer()
+	  coefficient,     % integer()
+	  otherPrimeInfos  % [#OtherPrimeInfo{}] | asn1_NOVALUE
+	 }.
+
+#'OtherPrimeInfo'{
+	prime,           % integer()
+	exponent,        % integer()
+	coefficient      % integer()
+ 	 }.	 
+
+  

+
+  

+    DSA
+     
Erlang representation of Digigital Signature Algorithm (DSA) keys

+    	 
+#'DSAPrivateKey',{
+	  version,      % integer()
+	  p,            % integer()
+	  q,            % integer()
+	  g,            % integer()
+	  y,            % integer()
+	  x             % integer()
+	  }.
+
+#'Dss-Parms',{
+         p,         % integer()
+	 q,         % integer()
+	 g          % integer()
+	 }. 
+	
+  

+
+  

+       ECDSA 
+       
Erlang representation of  Elliptic Curve Digital Signature Algorithm (ECDSA) keys follows:
 
+    
+    	 
+#'ECPrivateKey'{
+          version,       % integer()
+	  privateKey,    % binary()  
+	  parameters,    % der_encoded() - {'EcpkParameters', #'ECParameters'{}} |
+	                                   {'EcpkParameters', {namedCurve, oid()}} |
+	                                   {'EcpkParameters', 'NULL'} % Inherited by CA
+	  publicKey      % bitstring()
+	  }.
+	  
+#'ECParameters'{
+      version,    % integer()
+      fieldID,    % #'FieldID'{}
+      curve,      % #'Curve'{}
+      base,       % binary()       
+      order,      % integer()        
+      cofactor    % integer()
+      }.
+      
+#'Curve'{
+	a,        % binary()
+	b,        % binary() 
+	seed      % bitstring() - optional
+
+	}.
+
+#'FieldID'{
+	fieldType,    % oid()
+	parameters    % Depending on fieldType
+	}.
+
+#'ECPoint'{
+      point %  binary() - the public key
+      }.
+  

+
+  

+    PKIX Certificates   
+    
Erlang representation of PKIX certificates derived from ASN.1 
+    specifications see also X509 certificates (RFC 5280), also referred to as plain type,  are as follows:

+
+#'Certificate'{
+		tbsCertificate,        % #'TBSCertificate'{}
+		signatureAlgorithm,    % #'AlgorithmIdentifier'{} 
+		signature              % bitstring()
+	       }.
+
+#'TBSCertificate'{
+	  version,              % v1 | v2 | v3 
+	  serialNumber,         % integer() 
+	  signature,            % #'AlgorithmIdentifier'{} 
+	  issuer,               % {rdnSequence, [#AttributeTypeAndValue'{}]} 
+	  validity,             % #'Validity'{}
+	  subject,              % {rdnSequence, [#AttributeTypeAndValue'{}]} 
+	  subjectPublicKeyInfo, % #'SubjectPublicKeyInfo'{}
+	  issuerUniqueID,       % binary() | asn1_novalue
+	  subjectUniqueID,      % binary() | asn1_novalue
+	  extensions            % [#'Extension'{}] 
+	 }.
+	  
+#'AlgorithmIdentifier'{
+	  algorithm,  % oid() 
+	  parameters  % der_encoded()
+	 }.
+
+
Erlang alternate representation of PKIX certificate, also referred to as otp type

+	 
+
+#'OTPCertificate'{
+		tbsCertificate,        % #'OTPTBSCertificate'{}
+		signatureAlgorithm,    % #'SignatureAlgorithm'
+		signature              % bitstring()
+	       }.
+
+#'OTPTBSCertificate'{
+	  version,              % v1 | v2 | v3 
+	  serialNumber,         % integer() 
+	  signature,            % #'SignatureAlgorithm'
+	  issuer,               % {rdnSequence, [#AttributeTypeAndValue'{}]} 
+	  validity,             % #'Validity'{}
+	  subject,              % {rdnSequence, [#AttributeTypeAndValue'{}]} 
+	  subjectPublicKeyInfo, % #'OTPSubjectPublicKeyInfo'{}
+	  issuerUniqueID,       % binary() | asn1_novalue
+	  subjectUniqueID,      % binary() | asn1_novalue
+	  extensions            % [#'Extension'{}] 
+	 }.
+	  
+#'SignatureAlgorithm'{
+	  algorithm,  % id_signature_algorithm()
+	  parameters  % asn1_novalue | #'Dss-Parms'{}
+	 }.
+
+
id_signature_algorithm() = OID_macro()

+
+
The available OID names are as follows:

+
+  
+    OID Name
+  
+  
+    id-dsa-with-sha1
+      
+      
+	id-dsaWithSHA1 (ISO or OID to above)
+      
+       
+	md2WithRSAEncryption
+      
+      
+	md5WithRSAEncryption
+      
+      
+	sha1WithRSAEncryption
+      
+      
+	sha-1WithRSAEncryption (ISO or OID to above)
+      
+      
+	sha224WithRSAEncryption
+      
+       
+	sha256WithRSAEncryption
+      
+     
+	sha512WithRSAEncryption
+      
+        
+	  ecdsa-with-SHA1
+     
+      Signature Algorithm OIDs 
+

+    
+
The data type 'AttributeTypeAndValue', is represented as
+ the following erlang record:

+
+
+#'AttributeTypeAndValue'{
+	  type,   % id_attributes()
+	  value   % term() 
+	 }.
+
+
The attribute OID name atoms and their corresponding value types
+are as follows:

+
+  
+    OID Name
+    Value Type
+  
+  
+    id-at-name
+    special_string()
+        
+  
+    id-at-surname
+    special_string()
+  
+  
+    id-at-givenName
+    special_string()
+  
+  
+    id-at-initials 
+    special_string()
+  
+  
+    id-at-generationQualifier
+    special_string()
+  
+  
+    id-at-commonName
+    special_string()
+     
+  
+    id-at-localityName
+    special_string()
+  
+  
+    id-at-stateOrProvinceName
+    special_string()
+  
+  
+    id-at-organizationName
+    special_string()
+  
+  
+    id-at-title
+    special_string()
+  
+  
+    id-at-dnQualifier
+    {printableString, string()}
+  
+  
+    id-at-countryName
+    {printableString, string()}
+  
+  
+    id-at-serialNumber
+    {printableString, string()}
+        
+  
+    id-at-pseudonym
+    special_string()
+  
+  Attribute OIDs
+

+    
+
The data types 'Validity', 'SubjectPublicKeyInfo', and 
+'SubjectPublicKeyInfoAlgorithm' are represented as the following Erlang records:

+
+
+#'Validity'{ 
+	  notBefore, % time()
+	  notAfter   % time()
+	 }.
+	 
+#'SubjectPublicKeyInfo'{
+	  algorithm,       % #AlgorithmIdentifier{} 
+	  subjectPublicKey % binary() 
+	 }.
+
+#'SubjectPublicKeyInfoAlgorithm'{
+	  algorithm,  % id_public_key_algorithm()
+	  parameters  % public_key_params()
+	 }.
+
+
The public-key algorithm OID name atoms are as follows:

+
+  
+    OID Name
+  
+  
+    rsaEncryption
+      
+      
+	id-dsa
+      
+      
+	dhpublicnumber
+      
+      
+	id-keyExchangeAlgorithm
+      
+      
+	id-ecPublicKey
+      
+      Public-Key Algorithm OIDs
+

+    
+
+#'Extension'{
+	  extnID,    % id_extensions() | oid() 
+	  critical,  % boolean()
+	  extnValue  % der_encoded()
+	 }.
+
+
id_extensions()  
+  Standard Certificate Extensions, 
+  Private Internet Extensions,  
+  CRL Extensions and 
+  CRL Entry Extensions.
+

+    
+

+  
+

+  
+  Standard Certificate Extensions
+    
+  
The standard certificate extensions OID name atoms and their 
+  corresponding value types are as follows:

+
+  
+      
+	OID Name
+	Value Type
+      
+      
+	id-ce-authorityKeyIdentifier
+	#'AuthorityKeyIdentifier'{}
+      
+      
+	id-ce-subjectKeyIdentifier
+	oid()
+      
+      
+	id-ce-keyUsage
+	[key_usage()]
+      
+      
+	id-ce-privateKeyUsagePeriod
+	#'PrivateKeyUsagePeriod'{}
+      
+      
+	id-ce-certificatePolicies
+	#'PolicyInformation'{}
+      
+      
+      
+	id-ce-policyMappings
+	#'PolicyMappings_SEQOF'{}
+      
+      
+      
+	id-ce-subjectAltName
+	general_name()
+      
+
+      
+	id-ce-issuerAltName
+	general_name()
+      
+      
+      
+	id-ce-subjectDirectoryAttributes
+	 [#'Attribute'{}]
+      
+
+      
+          id-ce-basicConstraints
+	  #'BasicConstraints'{}
+      
+      
+	id-ce-nameConstraints
+	#'NameConstraints'{}
+      
+      
+	id-ce-policyConstraints
+	#'PolicyConstraints'{}
+      
+      
+	id-ce-extKeyUsage
+	[id_key_purpose()]
+      
+      
+      
+	id-ce-cRLDistributionPoints
+	[#'DistributionPoint'{}]
+      
+      
+      
+	id-ce-inhibitAnyPolicy
+	integer()
+      
+      
+      
+	id-ce-freshestCRL
+	[#'DistributionPoint'{}]
+      
+      
+      
+      Standard Certificate Extensions
+    

+
+    
Here:

+    
+      key_usage()
+      = 
digitalSignature

+      
| nonRepudiation

+      
| keyEncipherment

+      
| dataEncipherment

+      
| keyAgreement

+      
| keyCertSign

+      
| cRLSign

+      
| encipherOnly

+      
| decipherOnly 

+      
+    
+   
+    
And for id_key_purpose():

+    
+
+  
+    OID Name
+  
+  
+    id-kp-serverAuth
+      
+      
+	id-kp-clientAuth
+      
+      
+	id-kp-codeSigning
+      
+      
+	id-kp-emailProtection
+      
+       
+	id-kp-timeStamping
+      
+       
+	id-kp-OCSPSigning
+      
+      Key Purpose OIDs
+

+    
+    
+#'AuthorityKeyIdentifier'{
+	  keyIdentifier,	    % oid()
+	  authorityCertIssuer,      % general_name()
+	  authorityCertSerialNumber % integer() 
+	 }.
+
+#'PrivateKeyUsagePeriod'{
+	  notBefore,   % general_time()
+	  notAfter     % general_time()
+	 }.
+
+#'PolicyInformation'{
+	  policyIdentifier,  % oid()
+	  policyQualifiers   % [#PolicyQualifierInfo{}]
+	 }.
+
+#'PolicyQualifierInfo'{
+	  policyQualifierId,   % oid()
+	  qualifier            % string() | #'UserNotice'{}
+	 }.
+
+#'UserNotice'{
+         noticeRef,   % #'NoticeReference'{}
+	 explicitText % string()
+	 }.
+
+#'NoticeReference'{
+         organization,    % string()
+	 noticeNumbers    % [integer()]
+	 }.
+
+#'PolicyMappings_SEQOF'{
+	  issuerDomainPolicy,  % oid()
+	  subjectDomainPolicy  % oid()
+	 }.
+
+#'Attribute'{
+          type,  % oid()
+	  values % [der_encoded()]
+	  }).
+
+#'BasicConstraints'{
+	  cA,		    % boolean()
+	  pathLenConstraint % integer()
+	 }).
+
+#'NameConstraints'{
+	  permittedSubtrees, % [#'GeneralSubtree'{}]
+	  excludedSubtrees   % [#'GeneralSubtree'{}]
+	 }).
+
+#'GeneralSubtree'{
+	  base,    % general_name()
+	  minimum, % integer()
+	  maximum  % integer()
+	 }).
+
+#'PolicyConstraints'{
+	  requireExplicitPolicy, % integer()
+	  inhibitPolicyMapping   % integer()
+	 }).
+
+#'DistributionPoint'{
+	  distributionPoint, % {fullName, [general_name()]} | {nameRelativeToCRLIssuer,
+	  [#AttributeTypeAndValue{}]}
+	  reasons,           % [dist_reason()]
+	  cRLIssuer          % [general_name()]
+	 }).
+
+

+
+ 

+   
+   Private Internet Extensions   
+
+   
The private internet extensions OID name atoms and their corresponding value 
+   types are as follows:

+
+   
+        
+          OID Name
+          Value Type
+        
+        
+          id-pe-authorityInfoAccess
+          [#'AccessDescription'{}]
+        
+	
+          id-pe-subjectInfoAccess
+          [#'AccessDescription'{}]
+        
+        Private Internet Extensions
+      
   
+ 
+
+#'AccessDescription'{
+           accessMethod,    % oid()
+	   accessLocation   % general_name()
+	 }).
+
+ 

+ 
+

+    CRL and CRL Extensions Profile
+
+    
Erlang representation of CRL and CRL extensions profile 
+    derived from ASN.1 specifications and RFC 5280 are as follows:

+
+ 
+#'CertificateList'{
+          tbsCertList,        % #'TBSCertList{}
+          signatureAlgorithm, % #'AlgorithmIdentifier'{} 
+          signature           % bitstring()
+	  }).
+
+#'TBSCertList'{
+      version,             % v2 (if defined)
+      signature,           % #AlgorithmIdentifier{}
+      issuer,              % {rdnSequence, [#AttributeTypeAndValue'{}]} 
+      thisUpdate,          % time()
+      nextUpdate,          % time() 
+      revokedCertificates, % [#'TBSCertList_revokedCertificates_SEQOF'{}]
+      crlExtensions        % [#'Extension'{}]
+      }).
+
+#'TBSCertList_revokedCertificates_SEQOF'{
+         userCertificate,      % integer()
+ 	 revocationDate,       % timer()
+	 crlEntryExtensions    % [#'Extension'{}]
+	 }).
+ 
+ 

+   
+   CRL Extensions
+
+   
The CRL extensions OID name atoms and their corresponding value types are as follows:

+   
+   
+        
+        
+          OID Name
+          Value Type
+        
+        
+          id-ce-authorityKeyIdentifier
+          #'AuthorityKeyIdentifier{}
+        
+        
+          id-ce-issuerAltName
+          {rdnSequence, [#AttributeTypeAndValue'{}]}
+           
+	    
+          id-ce-cRLNumber
+          integer()
+           
+	    
+          id-ce-deltaCRLIndicator
+          integer()
+           
+	    
+          id-ce-issuingDistributionPoint
+          #'IssuingDistributionPoint'{}
+           
+	   
+          id-ce-freshestCRL
+          [#'Distributionpoint'{}]
+           
+	   
+        CRL Extensions
+      

+      
+      
Here, the data type 'IssuingDistributionPoint' is represented as 
+      the following Erlang record:

+
+      
+#'IssuingDistributionPoint'{
+          distributionPoint,         % {fullName, [general_name()]} | {nameRelativeToCRLIssuer,
+	  [#AttributeTypeAndValue'{}]}
+	  onlyContainsUserCerts,     % boolean()
+	  onlyContainsCACerts,       % boolean()
+	  onlySomeReasons,           % [dist_reason()]
+	  indirectCRL,               % boolean()
+	  onlyContainsAttributeCerts % boolean()
+	  }). 
+ 

+ 
+ 

+   
+   CRL Entry Extensions
+
+   
The CRL entry extensions OID name atoms and their corresponding value types are as follows:

+
+       
+        
+          OID Name
+          Value Type
+        
+        
+          id-ce-cRLReason
+          crl_reason()
+        
+        
+          id-ce-holdInstructionCode
+          oid()
+           
+	    
+          id-ce-invalidityDate
+          general_time()
+           
+	    
+          id-ce-certificateIssuer
+          general_name()
+           
+	   CRL Entry Extensions
+       

+
+
+       
Here:

+       
+      crl_reason()
+      = 
unspecified

+      
| keyCompromise

+      
| cACompromise

+      
| affiliationChanged

+      
| superseded

+      
| cessationOfOperation

+      
| certificateHold

+      
| removeFromCRL

+      
| privilegeWithdrawn

+      
| aACompromise

+      
+       
+
+ 

+
+ 

+   
+   PKCS#10 Certification Request
+   
Erlang representation of a PKCS#10 certification request 
+   derived from ASN.1 specifications and RFC 5280 are as follows:

+   
+#'CertificationRequest'{
+          certificationRequestInfo #'CertificationRequestInfo'{},
+	  signatureAlgorithm	   #'CertificationRequest_signatureAlgorithm'{}}.
+	  signature                bitstring()
+	  }
+
+#'CertificationRequestInfo'{
+	  version       atom(),
+	  subject       {rdnSequence, [#AttributeTypeAndValue'{}]} ,
+	  subjectPKInfo #'CertificationRequestInfo_subjectPKInfo'{},
+	  attributes    [#'AttributePKCS-10' {}]
+	  }
+
+#'CertificationRequestInfo_subjectPKInfo'{
+          algorithm		#'CertificationRequestInfo_subjectPKInfo_algorithm'{}
+	  subjectPublicKey 	  bitstring()
+	  }
+
+#'CertificationRequestInfo_subjectPKInfo_algorithm'{
+     algorithm = oid(),
+     parameters = der_encoded()
+}	  
+
+#'CertificationRequest_signatureAlgorithm'{
+     algorithm = oid(),
+     parameters = der_encoded()
+     }
+
+#'AttributePKCS-10'{
+    type = oid(),
+    values = [der_encoded()]
+}   
+ 

+

+
diff --git a/lib/public_key/doc/src/records.xml b/lib/public_key/doc/src/records.xml
deleted file mode 100644
index 9536167839..0000000000
--- a/lib/public_key/doc/src/records.xml
+++ /dev/null
@@ -1,841 +0,0 @@
-
-
-
-
-  

-    
-      2008
-      2015
-      Ericsson AB, All Rights Reserved
-    
-    
-  The contents of this file are subject to the Erlang Public License,
-  Version 1.1, (the "License"); you may not use this file except in
-  compliance with the License. You should have received a copy of the
-  Erlang Public License along with this software. If not, it can be
-  retrieved online at http://www.erlang.org/.
-
-  Software distributed under the License is distributed on an "AS IS"
-  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
-  the License for the specific language governing rights and limitations
-  under the License.
-
-  The Initial Developer of the Original Code is Ericsson AB.
-    
-
-    Public-Key Records
-    Ingela Anderton Andin
-    
-    
-    
-    
-    2008-02-06
-    A
-    public_key_records.xml
-  

-    
-  
This chapter briefly describes Erlang records derived from ASN.1
-  specifications used to handle public key infrastructure.
-  The scope is to describe the data types of each component,
-  not the semantics. For information on the
-  semantics, refer to the relevant standards and RFCs linked in the sections below.

-
-  
Use the following include directive to get access to the
-  records and constant macros described in the following sections:

-  
-   -include_lib("public_key/include/public_key.hrl"). 
-
- 

-    Data Types   
-
-    
Common non-standard Erlang
-    data types used to describe the record fields in the
-    following sections and which are not defined in the Public Key Reference Manual
-    follows here:

-    
-    
-      time()
-      
= uct_time() | general_time()

-
-      uct_time()
-      
= {utcTime, "YYMMDDHHMMSSZ"}

-
-      general_time()
-      
= {generalTime, "YYYYMMDDHHMMSSZ"}

- 
-      general_name()
-      = 
{rfc822Name, string()}

-      
| {dNSName, string()}

-      
| {x400Address, string()}

-      
| {directoryName, {rdnSequence, [#AttributeTypeAndValue'{}]}}

-      
| {eidPartyName, special_string()}

-      
| {eidPartyName, special_string(), special_string()}

-      
| {uniformResourceIdentifier, string()}

-      
| {ipAddress, string()}

-      
| {registeredId, oid()}

-      
| {otherName, term()}

-      
-
-      special_string()
-      = 
{teletexString, string()}

-      
| {printableString, string()}

-      
| {universalString, string()}

-      
| {utf8String, binary()}

-      
| {bmpString, string()}

-      
-
-      dist_reason()
-      = 
unused

-      
| keyCompromise

-      
| cACompromise

-      
| affiliationChanged

-      
| superseded

-      
| cessationOfOperation

-      
| certificateHold

-      
| privilegeWithdrawn

-      
| aACompromise

-      
-
-      OID_macro()
-      = 
?OID_name() 

-      
-      
-      OID_name()
-      = 
atom()

-      
-      
-    
-
-  

-  
-  

-    RSA
-    
Erlang representation of  
-    Rivest-Shamir-Adleman cryptosystem (RSA) keys follows:

-    
-    
-#'RSAPublicKey'{
-	  modulus,       % integer()
-	  publicExponent % integer()
-	  }.
-
-#'RSAPrivateKey'{
-          version,         % two-prime | multi
-	  modulus,         % integer()
-	  publicExponent,  % integer()
-	  privateExponent, % integer()
-	  prime1,          % integer() 
-	  prime2,          % integer()
-	  exponent1,       % integer()
-	  exponent2,       % integer()
-	  coefficient,     % integer()
-	  otherPrimeInfos  % [#OtherPrimeInfo{}] | asn1_NOVALUE
-	 }.
-
-#'OtherPrimeInfo'{
-	prime,           % integer()
-	exponent,        % integer()
-	coefficient      % integer()
- 	 }.	 
-
-  

-
-  

-    DSA
-     
Erlang representation of Digigital Signature Algorithm (DSA) keys

-    	 
-#'DSAPrivateKey',{
-	  version,      % integer()
-	  p,            % integer()
-	  q,            % integer()
-	  g,            % integer()
-	  y,            % integer()
-	  x             % integer()
-	  }.
-
-#'Dss-Parms',{
-         p,         % integer()
-	 q,         % integer()
-	 g          % integer()
-	 }. 
-	
-  

-
-  

-       ECDSA 
-       
Erlang representation of  Elliptic Curve Digital Signature Algorithm (ECDSA) keys follows:
 
-    
-    	 
-#'ECPrivateKey'{
-          version,       % integer()
-	  privateKey,    % binary()  
-	  parameters,    % der_encoded() - {'EcpkParameters', #'ECParameters'{}} |
-	                                   {'EcpkParameters', {namedCurve, oid()}} |
-	                                   {'EcpkParameters', 'NULL'} % Inherited by CA
-	  publicKey      % bitstring()
-	  }.
-	  
-#'ECParameters'{
-      version,    % integer()
-      fieldID,    % #'FieldID'{}
-      curve,      % #'Curve'{}
-      base,       % binary()       
-      order,      % integer()        
-      cofactor    % integer()
-      }.
-      
-#'Curve'{
-	a,        % binary()
-	b,        % binary() 
-	seed      % bitstring() - optional
-
-	}.
-
-#'FieldID'{
-	fieldType,    % oid()
-	parameters    % Depending on fieldType
-	}.
-
-#'ECPoint'{
-      point %  binary() - the public key
-      }.
-  

-
-  

-    PKIX Certificates   
-    
Erlang representation of PKIX certificates derived from ASN.1 
-    specifications see also X509 certificates (RFC 5280), also referred to as plain type,  are as follows:

-
-#'Certificate'{
-		tbsCertificate,        % #'TBSCertificate'{}
-		signatureAlgorithm,    % #'AlgorithmIdentifier'{} 
-		signature              % bitstring()
-	       }.
-
-#'TBSCertificate'{
-	  version,              % v1 | v2 | v3 
-	  serialNumber,         % integer() 
-	  signature,            % #'AlgorithmIdentifier'{} 
-	  issuer,               % {rdnSequence, [#AttributeTypeAndValue'{}]} 
-	  validity,             % #'Validity'{}
-	  subject,              % {rdnSequence, [#AttributeTypeAndValue'{}]} 
-	  subjectPublicKeyInfo, % #'SubjectPublicKeyInfo'{}
-	  issuerUniqueID,       % binary() | asn1_novalue
-	  subjectUniqueID,      % binary() | asn1_novalue
-	  extensions            % [#'Extension'{}] 
-	 }.
-	  
-#'AlgorithmIdentifier'{
-	  algorithm,  % oid() 
-	  parameters  % der_encoded()
-	 }.
-
-
Erlang alternate representation of PKIX certificate, also referred to as otp type

-	 
-
-#'OTPCertificate'{
-		tbsCertificate,        % #'OTPTBSCertificate'{}
-		signatureAlgorithm,    % #'SignatureAlgorithm'
-		signature              % bitstring()
-	       }.
-
-#'OTPTBSCertificate'{
-	  version,              % v1 | v2 | v3 
-	  serialNumber,         % integer() 
-	  signature,            % #'SignatureAlgorithm'
-	  issuer,               % {rdnSequence, [#AttributeTypeAndValue'{}]} 
-	  validity,             % #'Validity'{}
-	  subject,              % {rdnSequence, [#AttributeTypeAndValue'{}]} 
-	  subjectPublicKeyInfo, % #'OTPSubjectPublicKeyInfo'{}
-	  issuerUniqueID,       % binary() | asn1_novalue
-	  subjectUniqueID,      % binary() | asn1_novalue
-	  extensions            % [#'Extension'{}] 
-	 }.
-	  
-#'SignatureAlgorithm'{
-	  algorithm,  % id_signature_algorithm()
-	  parameters  % asn1_novalue | #'Dss-Parms'{}
-	 }.
-
-
id_signature_algorithm() = OID_macro()

-
-
The available OID names are as follows:

-
-  
-    OID Name
-  
-  
-    id-dsa-with-sha1
-      
-      
-	id-dsaWithSHA1 (ISO or OID to above)
-      
-       
-	md2WithRSAEncryption
-      
-      
-	md5WithRSAEncryption
-      
-      
-	sha1WithRSAEncryption
-      
-      
-	sha-1WithRSAEncryption (ISO or OID to above)
-      
-      
-	sha224WithRSAEncryption
-      
-       
-	sha256WithRSAEncryption
-      
-     
-	sha512WithRSAEncryption
-      
-        
-	  ecdsa-with-SHA1
-     
-      Signature Algorithm OIDs 
-

-    
-
The data type 'AttributeTypeAndValue', is represented as
- the following erlang record:

-
-
-#'AttributeTypeAndValue'{
-	  type,   % id_attributes()
-	  value   % term() 
-	 }.
-
-
The attribute OID name atoms and their corresponding value types
-are as follows:

-
-  
-    OID Name
-    Value Type
-  
-  
-    id-at-name
-    special_string()
-        
-  
-    id-at-surname
-    special_string()
-  
-  
-    id-at-givenName
-    special_string()
-  
-  
-    id-at-initials 
-    special_string()
-  
-  
-    id-at-generationQualifier
-    special_string()
-  
-  
-    id-at-commonName
-    special_string()
-     
-  
-    id-at-localityName
-    special_string()
-  
-  
-    id-at-stateOrProvinceName
-    special_string()
-  
-  
-    id-at-organizationName
-    special_string()
-  
-  
-    id-at-title
-    special_string()
-  
-  
-    id-at-dnQualifier
-    {printableString, string()}
-  
-  
-    id-at-countryName
-    {printableString, string()}
-  
-  
-    id-at-serialNumber
-    {printableString, string()}
-        
-  
-    id-at-pseudonym
-    special_string()
-  
-  Attribute OIDs
-

-    
-
The data types 'Validity', 'SubjectPublicKeyInfo', and 
-'SubjectPublicKeyInfoAlgorithm' are represented as the following Erlang records:

-
-
-#'Validity'{ 
-	  notBefore, % time()
-	  notAfter   % time()
-	 }.
-	 
-#'SubjectPublicKeyInfo'{
-	  algorithm,       % #AlgorithmIdentifier{} 
-	  subjectPublicKey % binary() 
-	 }.
-
-#'SubjectPublicKeyInfoAlgorithm'{
-	  algorithm,  % id_public_key_algorithm()
-	  parameters  % public_key_params()
-	 }.
-
-
The public-key algorithm OID name atoms are as follows:

-
-  
-    OID Name
-  
-  
-    rsaEncryption
-      
-      
-	id-dsa
-      
-      
-	dhpublicnumber
-      
-      
-	id-keyExchangeAlgorithm
-      
-      
-	id-ecPublicKey
-      
-      Public-Key Algorithm OIDs
-

-    
-
-#'Extension'{
-	  extnID,    % id_extensions() | oid() 
-	  critical,  % boolean()
-	  extnValue  % der_encoded()
-	 }.
-
-
id_extensions()  
-  Standard Certificate Extensions, 
-  Private Internet Extensions,  
-  CRL Extensions and 
-  CRL Entry Extensions.
-

-    
-

-  
-

-  
-  Standard Certificate Extensions
-    
-  
The standard certificate extensions OID name atoms and their 
-  corresponding value types are as follows:

-
-  
-      
-	OID Name
-	Value Type
-      
-      
-	id-ce-authorityKeyIdentifier
-	#'AuthorityKeyIdentifier'{}
-      
-      
-	id-ce-subjectKeyIdentifier
-	oid()
-      
-      
-	id-ce-keyUsage
-	[key_usage()]
-      
-      
-	id-ce-privateKeyUsagePeriod
-	#'PrivateKeyUsagePeriod'{}
-      
-      
-	id-ce-certificatePolicies
-	#'PolicyInformation'{}
-      
-      
-      
-	id-ce-policyMappings
-	#'PolicyMappings_SEQOF'{}
-      
-      
-      
-	id-ce-subjectAltName
-	general_name()
-      
-
-      
-	id-ce-issuerAltName
-	general_name()
-      
-      
-      
-	id-ce-subjectDirectoryAttributes
-	 [#'Attribute'{}]
-      
-
-      
-          id-ce-basicConstraints
-	  #'BasicConstraints'{}
-      
-      
-	id-ce-nameConstraints
-	#'NameConstraints'{}
-      
-      
-	id-ce-policyConstraints
-	#'PolicyConstraints'{}
-      
-      
-	id-ce-extKeyUsage
-	[id_key_purpose()]
-      
-      
-      
-	id-ce-cRLDistributionPoints
-	[#'DistributionPoint'{}]
-      
-      
-      
-	id-ce-inhibitAnyPolicy
-	integer()
-      
-      
-      
-	id-ce-freshestCRL
-	[#'DistributionPoint'{}]
-      
-      
-      
-      Standard Certificate Extensions
-    

-
-    
Here:

-    
-      key_usage()
-      = 
digitalSignature

-      
| nonRepudiation

-      
| keyEncipherment

-      
| dataEncipherment

-      
| keyAgreement

-      
| keyCertSign

-      
| cRLSign

-      
| encipherOnly

-      
| decipherOnly 

-      
-    
-   
-    
And for id_key_purpose():

-    
-
-  
-    OID Name
-  
-  
-    id-kp-serverAuth
-      
-      
-	id-kp-clientAuth
-      
-      
-	id-kp-codeSigning
-      
-      
-	id-kp-emailProtection
-      
-       
-	id-kp-timeStamping
-      
-       
-	id-kp-OCSPSigning
-      
-      Key Purpose OIDs
-

-    
-    
-#'AuthorityKeyIdentifier'{
-	  keyIdentifier,	    % oid()
-	  authorityCertIssuer,      % general_name()
-	  authorityCertSerialNumber % integer() 
-	 }.
-
-#'PrivateKeyUsagePeriod'{
-	  notBefore,   % general_time()
-	  notAfter     % general_time()
-	 }.
-
-#'PolicyInformation'{
-	  policyIdentifier,  % oid()
-	  policyQualifiers   % [#PolicyQualifierInfo{}]
-	 }.
-
-#'PolicyQualifierInfo'{
-	  policyQualifierId,   % oid()
-	  qualifier            % string() | #'UserNotice'{}
-	 }.
-
-#'UserNotice'{
-         noticeRef,   % #'NoticeReference'{}
-	 explicitText % string()
-	 }.
-
-#'NoticeReference'{
-         organization,    % string()
-	 noticeNumbers    % [integer()]
-	 }.
-
-#'PolicyMappings_SEQOF'{
-	  issuerDomainPolicy,  % oid()
-	  subjectDomainPolicy  % oid()
-	 }.
-
-#'Attribute'{
-          type,  % oid()
-	  values % [der_encoded()]
-	  }).
-
-#'BasicConstraints'{
-	  cA,		    % boolean()
-	  pathLenConstraint % integer()
-	 }).
-
-#'NameConstraints'{
-	  permittedSubtrees, % [#'GeneralSubtree'{}]
-	  excludedSubtrees   % [#'GeneralSubtree'{}]
-	 }).
-
-#'GeneralSubtree'{
-	  base,    % general_name()
-	  minimum, % integer()
-	  maximum  % integer()
-	 }).
-
-#'PolicyConstraints'{
-	  requireExplicitPolicy, % integer()
-	  inhibitPolicyMapping   % integer()
-	 }).
-
-#'DistributionPoint'{
-	  distributionPoint, % {fullName, [general_name()]} | {nameRelativeToCRLIssuer,
-	  [#AttributeTypeAndValue{}]}
-	  reasons,           % [dist_reason()]
-	  cRLIssuer          % [general_name()]
-	 }).
-
-

-
- 

-   
-   Private Internet Extensions   
-
-   
The private internet extensions OID name atoms and their corresponding value 
-   types are as follows:

-
-   
-        
-          OID Name
-          Value Type
-        
-        
-          id-pe-authorityInfoAccess
-          [#'AccessDescription'{}]
-        
-	
-          id-pe-subjectInfoAccess
-          [#'AccessDescription'{}]
-        
-        Private Internet Extensions
-      
   
- 
-
-#'AccessDescription'{
-           accessMethod,    % oid()
-	   accessLocation   % general_name()
-	 }).
-
- 

- 
-

-    CRL and CRL Extensions Profile
-
-    
Erlang representation of CRL and CRL extensions profile 
-    derived from ASN.1 specifications and RFC 5280 are as follows:

-
- 
-#'CertificateList'{
-          tbsCertList,        % #'TBSCertList{}
-          signatureAlgorithm, % #'AlgorithmIdentifier'{} 
-          signature           % bitstring()
-	  }).
-
-#'TBSCertList'{
-      version,             % v2 (if defined)
-      signature,           % #AlgorithmIdentifier{}
-      issuer,              % {rdnSequence, [#AttributeTypeAndValue'{}]} 
-      thisUpdate,          % time()
-      nextUpdate,          % time() 
-      revokedCertificates, % [#'TBSCertList_revokedCertificates_SEQOF'{}]
-      crlExtensions        % [#'Extension'{}]
-      }).
-
-#'TBSCertList_revokedCertificates_SEQOF'{
-         userCertificate,      % integer()
- 	 revocationDate,       % timer()
-	 crlEntryExtensions    % [#'Extension'{}]
-	 }).
- 
- 

-   
-   CRL Extensions
-
-   
The CRL extensions OID name atoms and their corresponding value types are as follows:

-   
-   
-        
-        
-          OID Name
-          Value Type
-        
-        
-          id-ce-authorityKeyIdentifier
-          #'AuthorityKeyIdentifier{}
-        
-        
-          id-ce-issuerAltName
-          {rdnSequence, [#AttributeTypeAndValue'{}]}
-           
-	    
-          id-ce-cRLNumber
-          integer()
-           
-	    
-          id-ce-deltaCRLIndicator
-          integer()
-           
-	    
-          id-ce-issuingDistributionPoint
-          #'IssuingDistributionPoint'{}
-           
-	   
-          id-ce-freshestCRL
-          [#'Distributionpoint'{}]
-           
-	   
-        CRL Extensions
-      

-      
-      
Here, the data type 'IssuingDistributionPoint' is represented as 
-      the following Erlang record:

-
-      
-#'IssuingDistributionPoint'{
-          distributionPoint,         % {fullName, [general_name()]} | {nameRelativeToCRLIssuer,
-	  [#AttributeTypeAndValue'{}]}
-	  onlyContainsUserCerts,     % boolean()
-	  onlyContainsCACerts,       % boolean()
-	  onlySomeReasons,           % [dist_reason()]
-	  indirectCRL,               % boolean()
-	  onlyContainsAttributeCerts % boolean()
-	  }). 
- 

- 
- 

-   
-   CRL Entry Extensions
-
-   
The CRL entry extensions OID name atoms and their corresponding value types are as follows:

-
-       
-        
-          OID Name
-          Value Type
-        
-        
-          id-ce-cRLReason
-          crl_reason()
-        
-        
-          id-ce-holdInstructionCode
-          oid()
-           
-	    
-          id-ce-invalidityDate
-          general_time()
-           
-	    
-          id-ce-certificateIssuer
-          general_name()
-           
-	   CRL Entry Extensions
-       

-
-
-       
Here:

-       
-      crl_reason()
-      = 
unspecified

-      
| keyCompromise

-      
| cACompromise

-      
| affiliationChanged

-      
| superseded

-      
| cessationOfOperation

-      
| certificateHold

-      
| removeFromCRL

-      
| privilegeWithdrawn

-      
| aACompromise

-      
-       
-
- 

-
- 

-   
-   PKCS#10 Certification Request
-   
Erlang representation of a PKCS#10 certification request 
-   derived from ASN.1 specifications and RFC 5280 are as follows:

-   
-#'CertificationRequest'{
-          certificationRequestInfo #'CertificationRequestInfo'{},
-	  signatureAlgorithm	   #'CertificationRequest_signatureAlgorithm'{}}.
-	  signature                bitstring()
-	  }
-
-#'CertificationRequestInfo'{
-	  version       atom(),
-	  subject       {rdnSequence, [#AttributeTypeAndValue'{}]} ,
-	  subjectPKInfo #'CertificationRequestInfo_subjectPKInfo'{},
-	  attributes    [#'AttributePKCS-10' {}]
-	  }
-
-#'CertificationRequestInfo_subjectPKInfo'{
-          algorithm		#'CertificationRequestInfo_subjectPKInfo_algorithm'{}
-	  subjectPublicKey 	  bitstring()
-	  }
-
-#'CertificationRequestInfo_subjectPKInfo_algorithm'{
-     algorithm = oid(),
-     parameters = der_encoded()
-}	  
-
-#'CertificationRequest_signatureAlgorithm'{
-     algorithm = oid(),
-     parameters = der_encoded()
-     }
-
-#'AttributePKCS-10'{
-    type = oid(),
-    values = [der_encoded()]
-}   
- 

-

-
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index cdf6870c25..46dc93e343 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -268,7 +268,7 @@ atom()}} |
 	application. It differentiates between the peer
 	certificate and the CA certificates by using valid_peer or
 	valid as second argument to the verification fun. See the
-	public_key User's
+	public_key User's
 	Guide for definition of #'OTPCertificate'{} and
 	#'Extension'{}.

 
@@ -364,10 +364,10 @@ marker="public_key:public_key#pkix_path_validation-3">public_key:pkix_path_valid
 	empty argument list. The following arguments may be specified for the internal cache.

 	
 	  {http, timeout()}
-	  
+	  

 	    Enables fetching of CRLs specified as http URIs in X509 cerificate extensions.
-	    Requires the OTP inets application.
+	    marker="public_key:public_key_records"> X509 cerificate extensions.
+	    Requires the OTP inets application.

 	  	    
 	    
       
diff --git a/lib/ssl/doc/src/ssl_crl_cache_api.xml b/lib/ssl/doc/src/ssl_crl_cache_api.xml
index 1d9353a2cc..90aa895aff 100644
--- a/lib/ssl/doc/src/ssl_crl_cache_api.xml
+++ b/lib/ssl/doc/src/ssl_crl_cache_api.xml
@@ -50,8 +50,8 @@
     cache_ref() 
      = opaque()
     dist_point()
-     = #'DistributionPoint'{} see  X509 certificates records
+    
 = #'DistributionPoint'{} see  X509 certificates records

     
     
     
-- 
cgit v1.2.3


From 05efdc8e2db3d7d3d845166424d71e4b061049e5 Mon Sep 17 00:00:00 2001
From: Hans Nilsson 
Date: Mon, 11 May 2015 13:33:39 +0200
Subject: eldap: Remove doc man.3 warning

---
 lib/eldap/doc/src/eldap.xml | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'lib')

diff --git a/lib/eldap/doc/src/eldap.xml b/lib/eldap/doc/src/eldap.xml
index ed35ee3a9c..a6fad8a857 100644
--- a/lib/eldap/doc/src/eldap.xml
+++ b/lib/eldap/doc/src/eldap.xml
@@ -403,7 +403,11 @@ filter()    See present/1, substrings/2,
 	OptionalAttrs = [Attr]
 	Attr = {matchingRule,string()} | {type,string()} | {dnAttributes,boolean()}
       
-       
Creates an extensible match filter. For example, eldap:extensibleMatch("Bar",[{type,"sn"},{matchingRule,"caseExactMatch"}])) creates a filter which performs a caseExactMatch on the attribute sn and matches with the value "Bar". The default value of dnAttributes is false.
 
+       
Creates an extensible match filter. For example, 

+      
+	eldap:extensibleMatch("Bar", [{type,"sn"}, {matchingRule,"caseExactMatch"}]))
+      
+      
creates a filter which performs a caseExactMatch on the attribute sn and matches with the value "Bar". The default value of dnAttributes is false.
 
     
     
       'and'([Filter]) -> filter()
-- 
cgit v1.2.3


From f630482b4e54b53b78434c6bfc11591ddfdcfbe7 Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin 
Date: Mon, 11 May 2015 16:27:20 +0200
Subject: public_key: Align "=" sign in type declarations to decided policy

---
 lib/public_key/doc/src/public_key.xml         | 157 +++++++++++++-------------
 lib/public_key/doc/src/public_key_records.xml |  32 +++---
 2 files changed, 97 insertions(+), 92 deletions(-)

(limited to 'lib')

diff --git a/lib/public_key/doc/src/public_key.xml b/lib/public_key/doc/src/public_key.xml
index 6d220c9b69..883c52393f 100644
--- a/lib/public_key/doc/src/public_key.xml
+++ b/lib/public_key/doc/src/public_key.xml
@@ -87,104 +87,109 @@
       oid()
       
Object identifier, a tuple of integers as generated by the ASN.1 compiler.

 
-      boolean()
-      
= true | false

-
-      string()
-      
= [bytes()]

-
-      der_encoded()
-      
= binary()

-
-      pki_asn1_type()
-      = 
'Certificate'

-      
| 'RSAPrivateKey'

-      
| 'RSAPublicKey'

-      
| 'DSAPrivateKey'

-      
| 'DSAPublicKey'

-      
| 'DHParameter'

-      
| 'SubjectPublicKeyInfo'

-      
| 'PrivateKeyInfo'

-      
| 'CertificationRequest'

-      
| 'ECPrivateKey'

-      
| 'EcpkParameters'

-
-      pem_entry ()
-      
= {pki_asn1_type(), binary(), %% DER or encrypted DER not_encrypted

-      
| cipher_info()}

+      boolean() =
+      
true | false

+      
+      string() =
+      
[bytes()]

+
+      der_encoded() =
+      
binary()

+
+      pki_asn1_type() =
+      
+	
'Certificate'

+	
| 'RSAPrivateKey'

+	
| 'RSAPublicKey'

+	
| 'DSAPrivateKey'

+	
| 'DSAPublicKey'

+	
| 'DHParameter'

+	
| 'SubjectPublicKeyInfo'

+	
| 'PrivateKeyInfo'

+	
| 'CertificationRequest'

+	
| 'ECPrivateKey'

+      
| 'EcpkParameters'

+      
 
-      cipher_info()
-      
= {"RC2-CBC" | "DES-CBC" | "DES-EDE3-CBC", crypto:rand_bytes(8)

+      pem_entry () =
+      
{pki_asn1_type(), binary(), %% DER or encrypted DER not_encrypted

+      
| cipher_info()}

+      
+      cipher_info() = 
+      
{"RC2-CBC" | "DES-CBC" | "DES-EDE3-CBC", crypto:rand_bytes(8)

       
| {#'PBEParameter{}, digest_type()} | #'PBES2-params'{}}

       
       
-      public_key()
-      
= rsa_public_key() | dsa_public_key() | ec_public_key()

-
-      private_key()
-      
= rsa_private_key() | dsa_private_key() | ec_private_key()

+      public_key() =
+      
rsa_public_key() | dsa_public_key() | ec_public_key()

+      
+      private_key() =
+      
rsa_private_key() | dsa_private_key() | ec_private_key()

 
-      rsa_public_key()
-      
= #'RSAPublicKey'{}

+      rsa_public_key() =
+      
#'RSAPublicKey'{}

 
-      rsa_private_key()
-      
= #'RSAPrivateKey'{}

+      rsa_private_key() =
+      
#'RSAPrivateKey'{}

 
-      dsa_public_key()
-      
= {integer(),  #'Dss-Parms'{}}

+      dsa_public_key() =
+      
{integer(),  #'Dss-Parms'{}}

 
-      dsa_private_key()
-      
= #'DSAPrivateKey'{}

+      dsa_private_key() =
+      
#'DSAPrivateKey'{}

 
       ec_public_key()
       
= {#'ECPoint'{}, #'EcpkParameters'{} | {namedCurve, oid()}}

 
-      ec_private_key()
-      
= #'ECPrivateKey'{}

+      ec_private_key() =
+      
#'ECPrivateKey'{}

 
-      public_crypt_options()
-      
= [{rsa_pad, rsa_padding()}]

+      public_crypt_options() =
+      
[{rsa_pad, rsa_padding()}]

 
-      rsa_padding()
-      
= 'rsa_pkcs1_padding'

-      
| 'rsa_pkcs1_oaep_padding'

-      
| 'rsa_no_padding'

+      rsa_padding() =
+      
+	
'rsa_pkcs1_padding'

+	
| 'rsa_pkcs1_oaep_padding'

+	
| 'rsa_no_padding'

       
 
-      digest_type()
+      digest_type() = 
       
Union of rsa_digest_type(), dss_digest_type(), 
       and ecdsa_digest_type().

 
-      rsa_digest_type()
-      
= 'md5' | 'sha' | 'sha224' | 'sha256' | 'sha384' | 'sha512'

-
-      dss_digest_type()
-      
= 'sha'

-
-      ecdsa_digest_type()
-      
= 'sha'| 'sha224' | 'sha256' | 'sha384' | 'sha512'

-
-      crl_reason()
-      
= unspecified

-      
| keyCompromise

-      
| cACompromise

-      
| affiliationChanged

-      
| superseded

-      
| cessationOfOperation

-      
| certificateHold

-      
| privilegeWithdrawn

-      
| aACompromise

-      
+      rsa_digest_type() = 
+      
'md5' | 'sha' | 'sha224' | 'sha256' | 'sha384' | 'sha512'

+
+      dss_digest_type() = 
+      
'sha'

 
-      issuer_name()
-      
= {rdnSequence,[#'AttributeTypeAndValue'{}]}
  
+      ecdsa_digest_type() = 
+      
'sha'| 'sha224' | 'sha256' | 'sha384' | 'sha512'

+      
+      crl_reason() = 
+      
+	
unspecified

+	
| keyCompromise

+	
| cACompromise

+	
| affiliationChanged

+	
| superseded

+	
| cessationOfOperation

+	
| certificateHold

+	
| privilegeWithdrawn

+	
| aACompromise

       
 
-      ssh_file()
-      
= openssh_public_key

-      
| rfc4716_public_key

-      
| known_hosts

-      
| auth_keys

+      issuer_name() =
+      
{rdnSequence,[#'AttributeTypeAndValue'{}]}
  
+      
+      
+      ssh_file() =
+      
+	
openssh_public_key

+	
| rfc4716_public_key

+	
| known_hosts

+	
| auth_keys

       
     
     
diff --git a/lib/public_key/doc/src/public_key_records.xml b/lib/public_key/doc/src/public_key_records.xml
index 9536167839..fc2a74a353 100644
--- a/lib/public_key/doc/src/public_key_records.xml
+++ b/lib/public_key/doc/src/public_key_records.xml
@@ -55,17 +55,17 @@
     follows here:

     
     
-      time()
-      
= uct_time() | general_time()

+      time() =
+      
uct_time() | general_time()

 
-      uct_time()
-      
= {utcTime, "YYMMDDHHMMSSZ"}

+      uct_time() =
+      
{utcTime, "YYMMDDHHMMSSZ"}

 
-      general_time()
-      
= {generalTime, "YYYYMMDDHHMMSSZ"}

+      general_time() =
+      
{generalTime, "YYYYMMDDHHMMSSZ"}

  
-      general_name()
-      = 
{rfc822Name, string()}

+      general_name() =
+      
{rfc822Name, string()}

       
| {dNSName, string()}

       
| {x400Address, string()}

       
| {directoryName, {rdnSequence, [#AttributeTypeAndValue'{}]}}

@@ -77,16 +77,16 @@
       
| {otherName, term()}

       
 
-      special_string()
-      = 
{teletexString, string()}

+      special_string() =
+      
{teletexString, string()}

       
| {printableString, string()}

       
| {universalString, string()}

       
| {utf8String, binary()}

       
| {bmpString, string()}

       
 
-      dist_reason()
-      = 
unused

+      dist_reason() =
+      
unused

       
| keyCompromise

       
| cACompromise

       
| affiliationChanged

@@ -97,12 +97,12 @@
       
| aACompromise

       
 
-      OID_macro()
-      = 
?OID_name() 

+      OID_macro() =
+      
?OID_name()

       
       
-      OID_name()
-      = 
atom()

+      OID_name() =
+      
atom()

       
       
     
-- 
cgit v1.2.3


From be5abeec807ab642881898033a3d23503ec91ce3 Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin 
Date: Mon, 11 May 2015 16:54:05 +0200
Subject: ssl: Align "=" sign in type declarations to decided policy

---
 lib/ssl/doc/src/ssl.xml | 124 ++++++++++++++++++++++++------------------------
 1 file changed, 63 insertions(+), 61 deletions(-)

(limited to 'lib')

diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index 46dc93e343..c4651d051c 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -67,15 +67,15 @@
 
     
 
-      boolean()
-      
= true | false

+      boolean() =
+      
true | false

 
-      option()
-      
= socketoption() | ssloption() | transportoption()

+      option() =
+      
socketoption() | ssloption() | transportoption()

       
 
-      socketoption()
-      
= proplists:property()

+      socketoption() =
+      
proplists:property()

       
The default socket options are
       [{mode,list},{packet, 0},{header, 0},{active, true}].

       
For valid options, see the
@@ -83,32 +83,34 @@
       gen_tcp(3) manual pages
       in Kernel.

 
-      ssloption()
-      
= {verify, verify_type()}

-      
| {verify_fun, {fun(), term()}}

-      
| {fail_if_no_peer_cert, boolean()} {depth, integer()}

-      
| {cert, public_key:der_encoded()}

-      
| {certfile, path()}

-      
| {key, {'RSAPrivateKey'| 'DSAPrivateKey' | 'ECPrivateKey' 
-      | 'PrivateKeyInfo', public_key:der_encoded()}}

-      
| {keyfile, path()}

-      
| {password, string()}

-      
| {cacerts, [public_key:der_encoded()]}

-      
| {cacertfile, path()}

-      
| {dh, public_key:der_encoded()}

-      
| {dhfile, path()}

-      
| {ciphers, ciphers()}

-      
| {user_lookup_fun, {fun(), term()}}, {psk_identity, string()},
-      {srp_identity, {string(), string()}}

-      
| {reuse_sessions, boolean()}

-      
| {reuse_session, fun()} {next_protocols_advertised, [binary()]}

-      
| {client_preferred_next_protocols, {client | server,
-      [binary()]} | {client | server, [binary()], binary()}}

-      
| {log_alert, boolean()}

-      
| {server_name_indication, hostname() | disable}

-
-      transportoption()
-      
= {cb_info, {CallbackModule::atom(), DataTag::atom(),
+      ssloption() =
+      
+	
{verify, verify_type()}

+	
| {verify_fun, {fun(), term()}}

+	
| {fail_if_no_peer_cert, boolean()} {depth, integer()}

+	
| {cert, public_key:der_encoded()}

+	
| {certfile, path()}

+	
| {key, {'RSAPrivateKey'| 'DSAPrivateKey' | 'ECPrivateKey' 
+	| 'PrivateKeyInfo', public_key:der_encoded()}}

+	
| {keyfile, path()}

+	
| {password, string()}

+	
| {cacerts, [public_key:der_encoded()]}

+	
| {cacertfile, path()}

+	
| {dh, public_key:der_encoded()}

+	
| {dhfile, path()}

+	
| {ciphers, ciphers()}

+	
| {user_lookup_fun, {fun(), term()}}, {psk_identity, string()},
+	{srp_identity, {string(), string()}}

+	
| {reuse_sessions, boolean()}

+	
| {reuse_session, fun()} {next_protocols_advertised, [binary()]}

+	
| {client_preferred_next_protocols, {client | server,
+	[binary()]} | {client | server, [binary()], binary()}}

+	
| {log_alert, boolean()}

+      
| {server_name_indication, hostname() | disable}

+      
+      
+      transportoption() =
+      
{cb_info, {CallbackModule::atom(), DataTag::atom(),
       ClosedTag::atom(), ErrTag:atom()}}

       
Defaults to {gen_tcp, tcp, tcp_closed, tcp_error}. Can be used
       to customize the transport layer. The callback module must implement a
@@ -129,57 +131,57 @@
       
       
 
-      verify_type()
-      
= verify_none | verify_peer

+      verify_type() =
+      
verify_none | verify_peer

 
-      path()
-      
= string()

+      path() =
+      
string()

       
Represents a file path.

 
-      public_key:der_encoded()
-      
= binary()

+      public_key:der_encoded() =
+      
binary()

       
ASN.1 DER-encoded entity as an Erlang binary.

 
-      host()
-      
= hostname() | ipaddress()

+      host() =
+      
hostname() | ipaddress()

 
-      hostname()
-      
= string()

+      hostname() =
+      
string()

 
-      ip_address()
-      
= {N1,N2,N3,N4} % IPv4 | {K1,K2,K3,K4,K5,K6,K7,K8} % IPv6
+      ip_address() =
+      
{N1,N2,N3,N4} % IPv4 | {K1,K2,K3,K4,K5,K6,K7,K8} % IPv6
       

 
-      sslsocket()
-      
Opaque to the user.

+      sslsocket() =
+      
opaque()

 
-      protocol()
-      
= sslv3 | tlsv1 | 'tlsv1.1' | 'tlsv1.2'

+      protocol() =
+      
sslv3 | tlsv1 | 'tlsv1.1' | 'tlsv1.2'

 
-      ciphers()
+      ciphers() =
       
= [ciphersuite()] | string()

       
According to old API.

 
-      ciphersuite()
-      
= {key_exchange(), cipher(), hash()}

+      ciphersuite() =
+      
{key_exchange(), cipher(), hash()}

 
-      key_exchange()
-      
= rsa | dhe_dss | dhe_rsa | dh_anon | psk | dhe_psk
+      key_exchange()=
+      
rsa | dhe_dss | dhe_rsa | dh_anon | psk | dhe_psk
       | rsa_psk | srp_anon | srp_dss | srp_rsa | ecdh_anon | ecdh_ecdsa
       | ecdhe_ecdsa | ecdh_rsa | ecdhe_rsa

 
-      cipher()
-      
= rc4_128 | des_cbc | '3des_ede_cbc'
+      cipher() =
+      
rc4_128 | des_cbc | '3des_ede_cbc'
       | aes_128_cbc | aes_256_cbc | aes_128_gcm | aes_256_gcm

 
-      hash()
-      
= md5 | sha

+      hash() =
+      
md5 | sha

 
-      prf_random()
-      
= client_random | server_random

+      prf_random() =
+      
client_random | server_random

 
-      srp_param_type()
-      
= srp_1024 | srp_1536 | srp_2048 | srp_3072
+      srp_param_type() =
+      
srp_1024 | srp_1536 | srp_2048 | srp_3072
       | srp_4096 | srp_6144 | srp_8192

 
     
-- 
cgit v1.2.3


From 878bd624d65515b68106bbed23a1bb9c09688034 Mon Sep 17 00:00:00 2001
From: Sverker Eriksson 
Date: Mon, 11 May 2015 18:00:28 +0200
Subject: crypto: Fix bug in generate_key(ecdh,...)

that could cause VM crash on faulty input.
---
 lib/crypto/c_src/crypto.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib')

diff --git a/lib/crypto/c_src/crypto.c b/lib/crypto/c_src/crypto.c
index 22c430bcd3..adacdcbc73 100644
--- a/lib/crypto/c_src/crypto.c
+++ b/lib/crypto/c_src/crypto.c
@@ -3749,7 +3749,7 @@ out:
 static ERL_NIF_TERM ec_key_generate(ErlNifEnv* env, int argc, const ERL_NIF_TERM argv[])
 {
 #if defined(HAVE_EC)
-    EC_KEY *key;
+    EC_KEY *key = NULL;
     const EC_GROUP *group;
     const EC_POINT *public_key;
     ERL_NIF_TERM priv_key;
-- 
cgit v1.2.3


From c93009b92f05ee65cf88ad7d9a40d60ffa9a99dd Mon Sep 17 00:00:00 2001
From: Peter Andersson 
Date: Mon, 11 May 2015 23:33:52 +0200
Subject: Update webtool version

---
 lib/webtool/vsn.mk | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'lib')

diff --git a/lib/webtool/vsn.mk b/lib/webtool/vsn.mk
index a79c273d9f..4a701ae6e0 100644
--- a/lib/webtool/vsn.mk
+++ b/lib/webtool/vsn.mk
@@ -1 +1 @@
-WEBTOOL_VSN=0.8.10
+WEBTOOL_VSN=0.9
-- 
cgit v1.2.3


From 86e95abae56c8999feccff42321db60f0c0362e3 Mon Sep 17 00:00:00 2001
From: Vlad Dumitrescu 
Date: Tue, 12 May 2015 08:20:49 +0200
Subject: Remove extra @param in javadoc

This gives an error when building the docs.
---
 lib/jinterface/java_src/com/ericsson/otp/erlang/OtpSelf.java | 3 ---
 1 file changed, 3 deletions(-)

(limited to 'lib')

diff --git a/lib/jinterface/java_src/com/ericsson/otp/erlang/OtpSelf.java b/lib/jinterface/java_src/com/ericsson/otp/erlang/OtpSelf.java
index 5b9d13ad81..74afbbcca6 100644
--- a/lib/jinterface/java_src/com/ericsson/otp/erlang/OtpSelf.java
+++ b/lib/jinterface/java_src/com/ericsson/otp/erlang/OtpSelf.java
@@ -153,9 +153,6 @@ public class OtpSelf extends OtpLocalNode {
      *            the port number you wish to use for incoming connections.
      *            Specifying 0 lets the system choose an available port.
      *
-     * @param transportFactory
-     *            the transport factory to use when creating connections.
-     *
      * @exception IOException
      *                in case of server transport failure
      */
-- 
cgit v1.2.3


From 4dde4fa2ac753223404a24bdb6a9e7323f04489e Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin 
Date: Fri, 8 May 2015 17:12:26 +0200
Subject: ssh: Fix typo

Option height was misspelled in the code. Fix code but recognize
the mispellt option for backwards compatible reasons.
---
 lib/ssh/src/ssh_connection.erl        | 18 ++++++++++++++----
 lib/ssh/test/ssh_connection_SUITE.erl |  2 +-
 2 files changed, 15 insertions(+), 5 deletions(-)

(limited to 'lib')

diff --git a/lib/ssh/src/ssh_connection.erl b/lib/ssh/src/ssh_connection.erl
index 388c080d99..d532d41009 100644
--- a/lib/ssh/src/ssh_connection.erl
+++ b/lib/ssh/src/ssh_connection.erl
@@ -196,15 +196,16 @@ reply_request(_,false, _, _) ->
 %%--------------------------------------------------------------------
 ptty_alloc(ConnectionHandler, Channel, Options) ->
     ptty_alloc(ConnectionHandler, Channel, Options, infinity).
-ptty_alloc(ConnectionHandler, Channel, Options, TimeOut) ->
+ptty_alloc(ConnectionHandler, Channel, Options0, TimeOut) ->
+    Options = backwards_compatible(Options0, []),
     {Width, PixWidth} = pty_default_dimensions(width, Options),
-    {Hight, PixHight} = pty_default_dimensions(hight, Options),
+    {Height, PixHeight} = pty_default_dimensions(height, Options),
     pty_req(ConnectionHandler, Channel,
 	    proplists:get_value(term, Options, os:getenv("TERM", ?DEFAULT_TERMINAL)),
 	    proplists:get_value(width, Options, Width),
-	    proplists:get_value(hight, Options, Hight),
+	    proplists:get_value(height, Options, Height),
 	    proplists:get_value(pixel_widh, Options, PixWidth),
-	    proplists:get_value(pixel_hight, Options, PixHight),
+	    proplists:get_value(pixel_height, Options, PixHeight),
 	    proplists:get_value(pty_opts, Options, []), TimeOut
 	   ).
 %%--------------------------------------------------------------------
@@ -1339,3 +1340,12 @@ decode_ip(Addr) when is_binary(Addr) ->
 	{error,_} -> Addr;
 	{ok,A}    -> A
     end.
+
+backwards_compatible([], Acc) ->
+    Acc;
+backwards_compatible([{hight, Value} | Rest], Acc) ->
+    backwards_compatible(Rest, [{height, Value} | Acc]);
+backwards_compatible([{pixel_hight, Value} | Rest], Acc) ->
+    backwards_compatible(Rest, [{height, Value} | Acc]);
+backwards_compatible([Value| Rest], Acc) ->
+    backwards_compatible(Rest, [ Value | Acc]).
diff --git a/lib/ssh/test/ssh_connection_SUITE.erl b/lib/ssh/test/ssh_connection_SUITE.erl
index 6fc09876ad..db51f65509 100644
--- a/lib/ssh/test/ssh_connection_SUITE.erl
+++ b/lib/ssh/test/ssh_connection_SUITE.erl
@@ -271,7 +271,7 @@ ptty_alloc(Config) when is_list(Config) ->
 							     {user_interaction, false}]),
     {ok, ChannelId} = ssh_connection:session_channel(ConnectionRef, infinity),
     success = ssh_connection:ptty_alloc(ConnectionRef, ChannelId, 
-					[{term, os:getenv("TERM", ?DEFAULT_TERMINAL)}, {width, 70}, {high, 20}]),
+					[{term, os:getenv("TERM", ?DEFAULT_TERMINAL)}, {width, 70}, {height, 20}]),
     ssh:close(ConnectionRef).
 
 
-- 
cgit v1.2.3


From e85487d4c50ace315292e8d6ab6f1b0b1cf800ca Mon Sep 17 00:00:00 2001
From: Hans Nilsson 
Date: Thu, 7 May 2015 21:03:36 +0200
Subject: ssh: Fix ssh_basic_SUITE.erl to work on Windows hosts

The test cases

   id_string_no_opt_client
   id_string_own_string_client
   id_string_random_client

didn't work on MS Windows.  This commit adds {packet,line} to get the
whole version exchange line in one packet on all architectures.  It
also adds timeouts to speed up failures in those test cases.
---
 lib/ssh/test/ssh_basic_SUITE.erl | 31 +++++++++++++++++++------------
 1 file changed, 19 insertions(+), 12 deletions(-)

(limited to 'lib')

diff --git a/lib/ssh/test/ssh_basic_SUITE.erl b/lib/ssh/test/ssh_basic_SUITE.erl
index bd029ad420..d55d09f2a2 100644
--- a/lib/ssh/test/ssh_basic_SUITE.erl
+++ b/lib/ssh/test/ssh_basic_SUITE.erl
@@ -823,56 +823,62 @@ ssh_daemon_minimal_remote_max_packet_size_option(Config) ->
     
 %%--------------------------------------------------------------------
 id_string_no_opt_client(Config) ->
-    {Server, Host, Port} = fake_daemon(Config),
-    {error,_} = ssh:connect(Host, Port, []),
+    {Server, _Host, Port} = fake_daemon(Config),
+    {error,_} = ssh:connect("localhost", Port, [], 1000),
     receive
 	{id,Server,"SSH-2.0-Erlang/"++Vsn} ->
 	    true = expected_ssh_vsn(Vsn);
 	{id,Server,Other} ->
 	    ct:fail("Unexpected id: ~s.",[Other])
+    after 5000 ->
+	    {fail,timeout}
     end.
 
 %%--------------------------------------------------------------------
 id_string_own_string_client(Config) ->
-    {Server, Host, Port} = fake_daemon(Config),
-    {error,_} = ssh:connect(Host, Port, [{id_string,"Pelle"}]),
+    {Server, _Host, Port} = fake_daemon(Config),
+    {error,_} = ssh:connect("localhost", Port, [{id_string,"Pelle"}], 1000),
     receive
 	{id,Server,"SSH-2.0-Pelle\r\n"} ->
 	    ok;
 	{id,Server,Other} ->
 	    ct:fail("Unexpected id: ~s.",[Other])
+    after 5000 ->
+	    {fail,timeout}
     end.
 
 %%--------------------------------------------------------------------
 id_string_random_client(Config) ->
-    {Server, Host, Port} = fake_daemon(Config),
-    {error,_} = ssh:connect(Host, Port, [{id_string,random}]),
+    {Server, _Host, Port} = fake_daemon(Config),
+    {error,_} = ssh:connect("localhost", Port, [{id_string,random}], 1000),
     receive
 	{id,Server,Id="SSH-2.0-Erlang"++_} ->
 	    ct:fail("Unexpected id: ~s.",[Id]);
 	{id,Server,Rnd="SSH-2.0-"++_} ->
-	    ct:log("Got ~s.",[Rnd]);
+	    ct:log("Got correct ~s",[Rnd]);
 	{id,Server,Id} ->
 	    ct:fail("Unexpected id: ~s.",[Id])
+    after 5000 ->
+	    {fail,timeout}
     end.
 
 %%--------------------------------------------------------------------
 id_string_no_opt_server(Config) ->
     {_Server, Host, Port} = std_daemon(Config, []),
-    {ok,S1}=gen_tcp:connect(Host,Port,[{active,false}]),
+    {ok,S1}=gen_tcp:connect(Host,Port,[{active,false},{packet,line}]),
     {ok,"SSH-2.0-Erlang/"++Vsn} = gen_tcp:recv(S1, 0, 2000),
     true = expected_ssh_vsn(Vsn).
 
 %%--------------------------------------------------------------------
 id_string_own_string_server(Config) ->
     {_Server, Host, Port} = std_daemon(Config, [{id_string,"Olle"}]),
-    {ok,S1}=gen_tcp:connect(Host,Port,[{active,false}]),
+    {ok,S1}=gen_tcp:connect(Host,Port,[{active,false},{packet,line}]),
     {ok,"SSH-2.0-Olle\r\n"} = gen_tcp:recv(S1, 0, 2000).
 
 %%--------------------------------------------------------------------
 id_string_random_server(Config) ->
     {_Server, Host, Port} = std_daemon(Config, [{id_string,random}]),
-    {ok,S1}=gen_tcp:connect(Host,Port,[{active,false}]),
+    {ok,S1}=gen_tcp:connect(Host,Port,[{active,false},{packet,line}]),
     {ok,"SSH-2.0-"++Rnd} = gen_tcp:recv(S1, 0, 2000),
     case Rnd of
 	"Erlang"++_ -> ct:log("Id=~p",[Rnd]),
@@ -1183,13 +1189,14 @@ expected_ssh_vsn(Str) ->
 	_:_ -> true %% ssh not started so we dont't know
     end.
 	    
-	    
+
 fake_daemon(_Config) ->
     Parent = self(),
     %% start the server
     Server = spawn(fun() ->
-			   {ok,Sl} = gen_tcp:listen(0,[]),
+			   {ok,Sl} = gen_tcp:listen(0,[{packet,line}]),
 			   {ok,{Host,Port}} = inet:sockname(Sl),
+			   ct:log("fake_daemon listening on ~p:~p~n",[Host,Port]),
 			   Parent ! {sockname,self(),Host,Port},
 			   Rsa = gen_tcp:accept(Sl),
 			   ct:log("Server gen_tcp:accept got ~p",[Rsa]),
-- 
cgit v1.2.3


From 6e24ffab6c682383a1c284fc066e59c680c4c62e Mon Sep 17 00:00:00 2001
From: Richard Carlsson 
Date: Mon, 20 Apr 2015 09:51:49 +0200
Subject: Add uptime() shell command

---
 lib/stdlib/doc/src/c.xml         |  8 ++++++++
 lib/stdlib/src/c.erl             | 23 ++++++++++++++++++++++-
 lib/stdlib/src/shell_default.erl |  3 ++-
 3 files changed, 32 insertions(+), 2 deletions(-)

(limited to 'lib')

diff --git a/lib/stdlib/doc/src/c.xml b/lib/stdlib/doc/src/c.xml
index b49fa6ad67..b43d4786ae 100644
--- a/lib/stdlib/doc/src/c.xml
+++ b/lib/stdlib/doc/src/c.xml
@@ -231,6 +231,14 @@ compile:file(File, Options ++ [report_errors, report_w
           in the network.

       
     
+    
+      
+      Print node uptime
+      
+        
Prints the node uptime (as given by
+           erlang:statistics(wall_clock)), in human-readable form.

+      
+    
     
       xm(ModSpec) -> void()
       Cross reference check a module
diff --git a/lib/stdlib/src/c.erl b/lib/stdlib/src/c.erl
index 9860adf04d..d5b24d3c32 100644
--- a/lib/stdlib/src/c.erl
+++ b/lib/stdlib/src/c.erl
@@ -27,7 +27,7 @@
 	 lc_batch/0, lc_batch/1,
 	 i/3,pid/3,m/0,m/1,
 	 bt/1, q/0,
-	 erlangrc/0,erlangrc/1,bi/1, flush/0, regs/0,
+	 erlangrc/0,erlangrc/1,bi/1, flush/0, regs/0, uptime/0,
 	 nregs/0,pwd/0,ls/0,ls/1,cd/1,memory/1,memory/0, xm/1]).
 
 -export([display_info/1]).
@@ -65,6 +65,7 @@ help() ->
 		   "q()        -- quit - shorthand for init:stop()\n"
 		   "regs()     -- information about registered processes\n"
 		   "nregs()    -- information about all registered processes\n"
+		   "uptime()   -- print node uptime\n"
 		   "xm(M)      -- cross reference check a module\n"
 		   "y(File)    -- generate a Yecc parser\n">>).
 
@@ -773,6 +774,26 @@ memory() -> erlang:memory().
 
 memory(TypeSpec) -> erlang:memory(TypeSpec).
 
+%%
+%% uptime/0
+%%
+
+-spec uptime() -> 'ok'.
+
+uptime() ->
+    io:format("~s~n", [uptime(get_uptime())]).
+
+uptime({D, {H, M, S}}) ->
+    lists:flatten(
+      [[ io_lib:format("~p days, ", [D]) || D > 0 ],
+       [ io_lib:format("~p hours, ", [H]) || D+H > 0 ],
+       [ io_lib:format("~p minutes and ", [M]) || D+H+M > 0 ],
+       io_lib:format("~p seconds", [S])]).
+
+get_uptime() ->
+    {UpTime, _} = erlang:statistics(wall_clock),
+    calendar:seconds_to_daystime(UpTime div 1000).
+
 %%
 %% Cross Reference Check
 %% 
diff --git a/lib/stdlib/src/shell_default.erl b/lib/stdlib/src/shell_default.erl
index 3fe359af0e..0fca7ff8c7 100644
--- a/lib/stdlib/src/shell_default.erl
+++ b/lib/stdlib/src/shell_default.erl
@@ -23,7 +23,7 @@
 -module(shell_default).
 
 -export([help/0,lc/1,c/1,c/2,nc/1,nl/1,l/1,i/0,pid/3,i/3,m/0,m/1,
-         memory/0,memory/1,
+         memory/0,memory/1,uptime/0,
 	 erlangrc/1,bi/1, regs/0, flush/0,pwd/0,ls/0,ls/1,cd/1, 
          y/1, y/2,
 	 xm/1, bt/1, q/0,
@@ -92,6 +92,7 @@ pid(X,Y,Z) 	-> c:pid(X,Y,Z).
 pwd()           -> c:pwd().
 q()		-> c:q().
 regs()          -> c:regs().
+uptime()        -> c:uptime().
 xm(Mod)         -> c:xm(Mod).
 y(File)         -> c:y(File).
 y(File, Opts)   -> c:y(File, Opts).
-- 
cgit v1.2.3


From 66c06dc602594b263225b5481d2abba653a3b5e8 Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin 
Date: Tue, 12 May 2015 11:21:20 +0200
Subject: ssh: Align "=" sign in type declarations to decided policy

---
 lib/ssh/doc/src/ssh.xml                | 43 +++++++++++++++++-----------------
 lib/ssh/doc/src/ssh_channel.xml        | 32 ++++++++++++-------------
 lib/ssh/doc/src/ssh_client_key_api.xml | 20 ++++++++--------
 lib/ssh/doc/src/ssh_connection.xml     | 42 ++++++++++++++++-----------------
 lib/ssh/doc/src/ssh_server_key_api.xml | 24 +++++++++----------
 lib/ssh/doc/src/ssh_sftp.xml           |  4 ++--
 lib/ssh/doc/src/ssh_sftpd.xml          | 16 ++++++-------
 7 files changed, 90 insertions(+), 91 deletions(-)

(limited to 'lib')

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index d49d3ac2a7..7cca84432e 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -57,29 +57,28 @@
     this module, or abstractions to indicate the intended use of the data
     type, or both:

     
-      boolean()
-      
= true | false

-      string()
-      
= [byte()]

-      ssh_daemon_ref()
-      
Opaque to the user,
-    returned by ssh:daemon/[1,2,3]

-      ssh_connection_ref()
-      
Opaque to the user,
-    returned by ssh:connect/3

-      ip_address()
+      boolean() =
+      
true | false

+      string() =
+      
[byte()]

+      ssh_daemon_ref() =
+      
opaque() -
+      as returned by ssh:daemon/[1,2,3]

+      ssh_connection_ref() =
+      
opaque() - as returned by ssh:connect/3

+      ip_address() =
       
inet::ip_address

-      subsystem_spec()
-      
= {subsystem_name(),
-    {channel_callback(), channel_init_args()}}

-      subsystem_name()
-      
= string()

-      channel_callback()
-      
= atom() - Name of the Erlang module
-    implementing the subsystem using the ssh_channel behavior, see
-    ssh_channel(3)

-      channel_init_args()
-      
= list()

+      subsystem_spec() =
+      
{subsystem_name(),
+      {channel_callback(), channel_init_args()}}

+      subsystem_name() =
+      
string()

+      channel_callback() =
+      
atom() - Name of the Erlang module
+      implementing the subsystem using the ssh_channel behavior, see
+      ssh_channel(3)

+      channel_init_args() =
+      
list()
diff --git a/lib/ssh/doc/src/ssh_channel.xml b/lib/ssh/doc/src/ssh_channel.xml index b8a03c350a..2fdecf9072 100644 --- a/lib/ssh/doc/src/ssh_channel.xml +++ b/lib/ssh/doc/src/ssh_channel.xml @@ -62,22 +62,22 @@ type, or both:

- boolean() -

= true | false

 - string() -

= list of ASCII characters

 - timeout() -

= infinity | integer() in milliseconds

 - ssh_connection_ref() -

Opaque to the user, returned by - ssh:connect/3 or sent to an SSH channel process

 - ssh_channel_id() -

= integer()

 - ssh_data_type_code() -

= 1 ("stderr") | 0 ("normal") are - the valid values, - see RFC 4254 - Section 5.2

 + boolean() = +

true | false

 + string() = +

list of ASCII characters

 + timeout() = +

infinity | integer() in milliseconds

 + ssh_connection_ref() = +

opaque() -as returned by + ssh:connect/3 or sent to an SSH channel process

 + ssh_channel_id() = +

integer()

 + ssh_data_type_code() = +

1 ("stderr") | 0 ("normal") are + the valid values, + see RFC 4254 + Section 5.2
diff --git a/lib/ssh/doc/src/ssh_client_key_api.xml b/lib/ssh/doc/src/ssh_client_key_api.xml index a8dda042c9..9a892d71fd 100644 --- a/lib/ssh/doc/src/ssh_client_key_api.xml +++ b/lib/ssh/doc/src/ssh_client_key_api.xml @@ -50,16 +50,16 @@ public_key user's guide:

- boolean() -

= true | false

 - string() -

= [byte()]

 - public_key() -

= #'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()

 - private_key() -

= #'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()

 - public_key_algorithm() -

= 'ssh-rsa'| 'ssh-dss' | atom()

 + boolean() = +

true | false

 + string() = +

[byte()]

 + public_key() = +

#'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()

 + private_key() = +

#'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()

 + public_key_algorithm() = +

'ssh-rsa'| 'ssh-dss' | atom()
diff --git a/lib/ssh/doc/src/ssh_connection.xml b/lib/ssh/doc/src/ssh_connection.xml index 669a361db9..5422633dc3 100644 --- a/lib/ssh/doc/src/ssh_connection.xml +++ b/lib/ssh/doc/src/ssh_connection.xml @@ -56,29 +56,29 @@ type, or both:

- boolean() -

= true | false

- string() -

= list of ASCII characters

 - timeout() -

= infinity | integer() in milliseconds

 - ssh_connection_ref() -

Opaque to the user, returned by - ssh:connect/3 or sent to an SSH channel processes

 - ssh_channel_id() -

= integer()

 - ssh_data_type_code() -

= 1 ("stderr") | 0 ("normal") are + boolean() = +

true | false

+ string() = +

list of ASCII characters

 + timeout() = +

infinity | integer() in milliseconds

 + ssh_connection_ref() = +

opaque() -as returned by + ssh:connect/3 or sent to an SSH channel processes

 + ssh_channel_id() = +

integer()

 + ssh_data_type_code() = +

1 ("stderr") | 0 ("normal") are valid values, see RFC 4254 Section 5.2.

 - ssh_request_status() ssh_request_status() -

= success | failure

 - event() -

= {ssh_cm, ssh_connection_ref(), ssh_event_msg()}

 - ssh_event_msg() -

= data_events() | status_events() | terminal_events()

 - reason() -

= timeout | closed

 + ssh_request_status() = +

success | failure

 + event() = +

{ssh_cm, ssh_connection_ref(), ssh_event_msg()}

 + ssh_event_msg() = +

data_events() | status_events() | terminal_events()

 + reason() = +

timeout | closed

 diff --git a/lib/ssh/doc/src/ssh_server_key_api.xml b/lib/ssh/doc/src/ssh_server_key_api.xml index 34ce7f7660..73dd90c962 100644 --- a/lib/ssh/doc/src/ssh_server_key_api.xml +++ b/lib/ssh/doc/src/ssh_server_key_api.xml @@ -50,20 +50,20 @@ public_key user's guide.

- - boolean() -

= true | false

 - string() -

= [byte()]

 - public_key() -

= #'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()

 - private_key() -

= #'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()

 - public_key_algorithm() -

= 'ssh-rsa'| 'ssh-dss' | atom()

 + + boolean() = +

true | false

 + string() = +

[byte()]

 + public_key() = +

#'RSAPublicKey'{}| {integer(), #'Dss-Parms'{}}| term()

 + private_key() = +

#'RSAPrivateKey'{} | #'DSAPrivateKey'{} | term()

 + public_key_algorithm() = +

'ssh-rsa'| 'ssh-dss' | atom()
- + Module:host_key(Algorithm, DaemonOptions) -> diff --git a/lib/ssh/doc/src/ssh_sftp.xml b/lib/ssh/doc/src/ssh_sftp.xml index 643130fe6b..fc418bc934 100644 --- a/lib/ssh/doc/src/ssh_sftp.xml +++ b/lib/ssh/doc/src/ssh_sftp.xml @@ -43,8 +43,8 @@

- ssh_connection_ref() -

Opaque to the user, returned by ssh:connect/3

 + ssh_connection_ref() = +

opaque() - as returned by ssh:connect/3

 timeout()

= infinity | integer() in milliseconds. Default infinity.

 diff --git a/lib/ssh/doc/src/ssh_sftpd.xml b/lib/ssh/doc/src/ssh_sftpd.xml index bc2660f595..8b2497e6a3 100644 --- a/lib/ssh/doc/src/ssh_sftpd.xml +++ b/lib/ssh/doc/src/ssh_sftpd.xml @@ -37,16 +37,16 @@
DATA TYPES - subsystem_spec() -

= {subsystem_name(), {channel_callback(), channel_init_args()}}

 - subsystem_name() -

= "sftp"

 - channel_callback() -

= atom() - Name of the Erlang module implementing the subsystem using the + subsystem_spec() = +

{subsystem_name(), {channel_callback(), channel_init_args()}}

 + subsystem_name() = +

"sftp"

 + channel_callback() = +

atom() - Name of the Erlang module implementing the subsystem using the ssh_channel behavior, see the ssh_channel(3) manual page.

 - channel_init_args() -

= list() - The one given as argument to function subsystem_spec/1.

 + channel_init_args() = +

list() - The one given as argument to function subsystem_spec/1.
-- cgit v1.2.3 From 4fe38c4b8b2c8024afb60990e598ff823743fd54 Mon Sep 17 00:00:00 2001 From: Qijiang Fan Date: Tue, 30 Dec 2014 22:40:28 +0800 Subject: ssl: add SNI server support --- lib/ssl/src/ssl.erl | 15 +++++++++++++-- lib/ssl/src/ssl_connection.erl | 16 ++++++++++++++-- lib/ssl/src/ssl_connection.hrl | 3 ++- lib/ssl/src/ssl_internal.hrl | 1 + lib/ssl/src/tls_connection.erl | 42 +++++++++++++++++++++++++++++++++++++++++- 5 files changed, 71 insertions(+), 6 deletions(-) (limited to 'lib') diff --git a/lib/ssl/src/ssl.erl b/lib/ssl/src/ssl.erl index 6461f64c1c..54cc5e71b6 100644 --- a/lib/ssl/src/ssl.erl +++ b/lib/ssl/src/ssl.erl @@ -40,7 +40,7 @@ connection_info/1, versions/0, session_info/1, format_error/1, renegotiate/1, prf/5, negotiated_protocol/1, negotiated_next_protocol/1]). %% Misc --export([random_bytes/1]). +-export([random_bytes/1, handle_options/2]). -deprecated({negotiated_next_protocol, 1, next_major_release}). @@ -671,6 +671,7 @@ handle_options(Opts0) -> handle_option(client_preferred_next_protocols, Opts, undefined)), log_alert = handle_option(log_alert, Opts, true), server_name_indication = handle_option(server_name_indication, Opts, undefined), + sni_hosts = handle_option(sni_hosts, Opts, []), honor_cipher_order = handle_option(honor_cipher_order, Opts, false), protocol = proplists:get_value(protocol, Opts, tls), padding_check = proplists:get_value(padding_check, Opts, true), @@ -687,7 +688,7 @@ handle_options(Opts0) -> user_lookup_fun, psk_identity, srp_identity, ciphers, reuse_session, reuse_sessions, ssl_imp, cb_info, renegotiate_at, secure_renegotiate, hibernate_after, - erl_dist, alpn_advertised_protocols, + erl_dist, alpn_advertised_protocols, sni_hosts, alpn_preferred_protocols, next_protocols_advertised, client_preferred_next_protocols, log_alert, server_name_indication, honor_cipher_order, padding_check, crl_check, crl_cache, @@ -881,6 +882,10 @@ validate_option(server_name_indication, disable) -> disable; validate_option(server_name_indication, undefined) -> undefined; +validate_option(sni_hosts, []) -> + []; +validate_option(sni_hosts, [{Hostname, SSLOptions} | Tail]) when is_list(Hostname) -> + [{Hostname, validate_options(SSLOptions)} | validate_option(sni_hosts, Tail)]; validate_option(honor_cipher_order, Value) when is_boolean(Value) -> Value; validate_option(padding_check, Value) when is_boolean(Value) -> @@ -896,6 +901,12 @@ validate_option(crl_cache, {Cb, {_Handle, Options}} = Value) when is_atom(Cb) an validate_option(Opt, Value) -> throw({error, {options, {Opt, Value}}}). + +validate_options([]) -> + []; +validate_options([{Opt, Value} | Tail]) -> + [{Opt, validate_option(Opt, Value)} | validate_options(Tail)]. + validate_npn_ordering(client) -> ok; validate_npn_ordering(server) -> diff --git a/lib/ssl/src/ssl_connection.erl b/lib/ssl/src/ssl_connection.erl index 4a839872a6..2c0b1b6257 100644 --- a/lib/ssl/src/ssl_connection.erl +++ b/lib/ssl/src/ssl_connection.erl @@ -42,7 +42,8 @@ %% User Events -export([send/2, recv/3, close/1, shutdown/2, new_user/2, get_opts/2, set_opts/2, info/1, session_info/1, - peer_certificate/1, renegotiation/1, negotiated_protocol/1, prf/5 + peer_certificate/1, renegotiation/1, negotiated_protocol/1, prf/5, + sni_hostname/1 ]). -export([handle_session/7]). @@ -160,6 +161,14 @@ send(Pid, Data) -> recv(Pid, Length, Timeout) -> sync_send_all_state_event(Pid, {recv, Length, Timeout}). +%%-------------------------------------------------------------------- +-spec sni_hostname(pid()) -> undefined | string(). +%% +%% Description: Get the SNI hostname +%%-------------------------------------------------------------------- +sni_hostname(Pid) when is_pid(Pid) -> + sync_send_all_state_event(Pid, sni_hostname). + %%-------------------------------------------------------------------- -spec close(pid()) -> ok | {error, reason()}. %% @@ -845,7 +854,10 @@ handle_sync_event(session_info, _, StateName, handle_sync_event(peer_certificate, _, StateName, #state{session = #session{peer_certificate = Cert}} = State) -> - {reply, {ok, Cert}, StateName, State, get_timeout(State)}. + {reply, {ok, Cert}, StateName, State, get_timeout(State)}; +handle_sync_event(sni_hostname, _, StateName, #state{sni_hostname = SNIHostname} = State) -> + {reply, SNIHostname, StateName, State}. + handle_info({ErrorTag, Socket, econnaborted}, StateName, #state{socket = Socket, transport_cb = Transport, diff --git a/lib/ssl/src/ssl_connection.hrl b/lib/ssl/src/ssl_connection.hrl index e569d706af..d95b51132a 100644 --- a/lib/ssl/src/ssl_connection.hrl +++ b/lib/ssl/src/ssl_connection.hrl @@ -80,7 +80,8 @@ expecting_finished = false ::boolean(), negotiated_protocol = undefined :: undefined | binary(), client_ecc, % {Curves, PointFmt} - tracker :: pid() %% Tracker process for listen socket + tracker :: pid(), %% Tracker process for listen socket + sni_hostname = undefined }). -define(DEFAULT_DIFFIE_HELLMAN_PARAMS, diff --git a/lib/ssl/src/ssl_internal.hrl b/lib/ssl/src/ssl_internal.hrl index 90f8b8a412..e285f48202 100644 --- a/lib/ssl/src/ssl_internal.hrl +++ b/lib/ssl/src/ssl_internal.hrl @@ -122,6 +122,7 @@ next_protocol_selector = undefined, %% fun([binary()]) -> binary()) log_alert :: boolean(), server_name_indication = undefined, + sni_hosts :: [{inet:hostname(), [tuple()]}], %% Should the server prefer its own cipher order over the one provided by %% the client? honor_cipher_order = false :: boolean(), diff --git a/lib/ssl/src/tls_connection.erl b/lib/ssl/src/tls_connection.erl index 0577222980..d804d7ad37 100644 --- a/lib/ssl/src/tls_connection.erl +++ b/lib/ssl/src/tls_connection.erl @@ -398,6 +398,15 @@ initial_state(Role, Host, Port, Socket, {SSLOptions, SocketOptions, Tracker}, Us tracker = Tracker }. + +update_ssl_options_from_sni(OrigSSLOptions, SNIHostname) -> + case proplists:get_value(SNIHostname, OrigSSLOptions#ssl_options.sni_hosts) of + undefined -> + undefined; + SSLOption -> + ssl:handle_options(SSLOption, OrigSSLOptions) + end. + next_state(Current,_, #alert{} = Alert, #state{negotiated_version = Version} = State) -> handle_own_alert(Alert, Version, Current, State); @@ -439,7 +448,38 @@ next_state(Current, Next, #ssl_tls{type = ?HANDSHAKE, fragment = Data}, end, try {Packets, Buf} = tls_handshake:get_tls_handshake(Version,Data,Buf0), - State = State0#state{protocol_buffers = + State1 = case Packets of + [{#client_hello{extensions=HelloExtensions} = ClientHello, _}] -> + case HelloExtensions#hello_extensions.sni of + undefined -> + State0; + #sni{hostname = Hostname} -> + OrigSSLOptions = State0#state.ssl_options, + NewOptions = update_ssl_options_from_sni(State0#state.ssl_options, Hostname), + case NewOptions of + undefined -> + State0; + _ -> + {ok, Ref, CertDbHandle, FileRefHandle, CacheHandle, CRLDbHandle, OwnCert, Key, DHParams} = + ssl_config:init(NewOptions, State0#state.role), + State0#state{ + session = State0#state.session#session{own_certificate = OwnCert}, + file_ref_db = FileRefHandle, + cert_db_ref = Ref, + cert_db = CertDbHandle, + crl_db = CRLDbHandle, + session_cache = CacheHandle, + private_key = Key, + diffie_hellman_params = DHParams, + ssl_options = NewOptions, + sni_hostname = Hostname + } + end + end; + _ -> + State0 + end, + State = State1#state{protocol_buffers = Buffers#protocol_buffers{tls_packets = Packets, tls_handshake_buffer = Buf}}, handle_tls_handshake(Handle, Next, State) -- cgit v1.2.3 From 1e2569973101aaccdbb0c552948134cb1a58a7fd Mon Sep 17 00:00:00 2001 From: Qijiang Fan Date: Tue, 30 Dec 2014 22:51:33 +0800 Subject: ssl: deny recursively defined sni_hosts --- lib/ssl/src/ssl.erl | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/ssl/src/ssl.erl b/lib/ssl/src/ssl.erl index 54cc5e71b6..cebfb9e5ce 100644 --- a/lib/ssl/src/ssl.erl +++ b/lib/ssl/src/ssl.erl @@ -885,7 +885,13 @@ validate_option(server_name_indication, undefined) -> validate_option(sni_hosts, []) -> []; validate_option(sni_hosts, [{Hostname, SSLOptions} | Tail]) when is_list(Hostname) -> - [{Hostname, validate_options(SSLOptions)} | validate_option(sni_hosts, Tail)]; + RecursiveSNIOptions = proplists:get_value(sni_hosts, SSLOptions, undefined), + case RecursiveSNIOptions of + undefined -> + [{Hostname, validate_options(SSLOptions)} | validate_option(sni_hosts, Tail)]; + _ -> + throw({error, {options, {sni_hosts, RecursiveSNIOptions}}}) + end; validate_option(honor_cipher_order, Value) when is_boolean(Value) -> Value; validate_option(padding_check, Value) when is_boolean(Value) -> -- cgit v1.2.3 From 9fe3bc8eb1e982ecd4680d9f354dc6ba3f066904 Mon Sep 17 00:00:00 2001 From: Qijiang Fan Date: Wed, 28 Jan 2015 15:20:21 +0800 Subject: ssl: add ssl:connection_information/[1,2] This commit adds a new function, ssl:connection_information/[1,2] to retrive the connection information from a SSLSocket. And also, this deprecates a function ssl:connection_info/1, and reimplements connection_info/1 with the new function. --- lib/ssl/src/ssl.erl | 38 +++++++++++++++++++++++++++++++++----- lib/ssl/src/ssl_connection.erl | 29 +++++++---------------------- lib/stdlib/src/otp_internal.erl | 3 +++ 3 files changed, 43 insertions(+), 27 deletions(-) (limited to 'lib') diff --git a/lib/ssl/src/ssl.erl b/lib/ssl/src/ssl.erl index cebfb9e5ce..956c699c45 100644 --- a/lib/ssl/src/ssl.erl +++ b/lib/ssl/src/ssl.erl @@ -38,11 +38,13 @@ %% SSL/TLS protocol handling -export([cipher_suites/0, cipher_suites/1, suite_definition/1, connection_info/1, versions/0, session_info/1, format_error/1, - renegotiate/1, prf/5, negotiated_protocol/1, negotiated_next_protocol/1]). + renegotiate/1, prf/5, negotiated_protocol/1, negotiated_next_protocol/1, + connection_information/1, connection_information/2]). %% Misc -export([random_bytes/1, handle_options/2]). -deprecated({negotiated_next_protocol, 1, next_major_release}). +-deprecated({connection_info, 1, next_major_release}). -include("ssl_api.hrl"). -include("ssl_internal.hrl"). @@ -286,16 +288,42 @@ controlling_process(#sslsocket{pid = {Listen, is_pid(NewOwner) -> Transport:controlling_process(Listen, NewOwner). + +%%-------------------------------------------------------------------- +-spec connection_information(#sslsocket{}) -> {ok, list()} | {error, reason()}. +%% +%% Description: Return SSL information for the connection +%%-------------------------------------------------------------------- +connection_information(#sslsocket{pid = Pid}) when is_pid(Pid) -> ssl_connection:connection_information(Pid); +connection_information(#sslsocket{pid = {Listen, _}}) when is_port(Listen) -> {error, enotconn}. + + +%%-------------------------------------------------------------------- +-spec connection_information(#sslsocket{}, [atom]) -> {ok, list()} | {error, reason()}. +%% +%% Description: Return SSL information for the connection +%%-------------------------------------------------------------------- +connection_information(#sslsocket{} = SSLSocket, Items) -> + case connection_information(SSLSocket) of + {ok, I} -> + {ok, lists:filter(fun({K, _}) -> lists:foldl(fun(K1, Acc) when K1 =:= K -> Acc + 1; (_, Acc) -> Acc end, 0, Items) > 0 end, I)}; + E -> + E + end. + %%-------------------------------------------------------------------- -spec connection_info(#sslsocket{}) -> {ok, {tls_record:tls_atom_version(), ssl_cipher:erl_cipher_suite()}} | {error, reason()}. %% %% Description: Returns ssl protocol and cipher used for the connection %%-------------------------------------------------------------------- -connection_info(#sslsocket{pid = Pid}) when is_pid(Pid) -> - ssl_connection:info(Pid); -connection_info(#sslsocket{pid = {Listen, _}}) when is_port(Listen) -> - {error, enotconn}. +connection_info(#sslsocket{} = SSLSocket) -> + case connection_information(SSLSocket) of + {ok, Result} -> + {ok, {proplists:get_value(protocol, Result), proplists:get_value(cipher_suite, Result)}}; + Error -> + Error + end. %%-------------------------------------------------------------------- -spec peername(#sslsocket{}) -> {ok, {inet:ip_address(), inet:port_number()}} | {error, reason()}. diff --git a/lib/ssl/src/ssl_connection.erl b/lib/ssl/src/ssl_connection.erl index 2c0b1b6257..64fa7bab0d 100644 --- a/lib/ssl/src/ssl_connection.erl +++ b/lib/ssl/src/ssl_connection.erl @@ -41,9 +41,9 @@ %% User Events -export([send/2, recv/3, close/1, shutdown/2, - new_user/2, get_opts/2, set_opts/2, info/1, session_info/1, + new_user/2, get_opts/2, set_opts/2, session_info/1, peer_certificate/1, renegotiation/1, negotiated_protocol/1, prf/5, - sni_hostname/1 + connection_information/1 ]). -export([handle_session/7]). @@ -162,12 +162,12 @@ recv(Pid, Length, Timeout) -> sync_send_all_state_event(Pid, {recv, Length, Timeout}). %%-------------------------------------------------------------------- --spec sni_hostname(pid()) -> undefined | string(). +-spec connection_information(pid()) -> {ok, list()} | {error, reason()}. %% %% Description: Get the SNI hostname %%-------------------------------------------------------------------- -sni_hostname(Pid) when is_pid(Pid) -> - sync_send_all_state_event(Pid, sni_hostname). +connection_information(Pid) when is_pid(Pid) -> + sync_send_all_state_event(Pid, connection_information). %%-------------------------------------------------------------------- -spec close(pid()) -> ok | {error, reason()}. @@ -222,14 +222,6 @@ get_opts(ConnectionPid, OptTags) -> set_opts(ConnectionPid, Options) -> sync_send_all_state_event(ConnectionPid, {set_opts, Options}). -%%-------------------------------------------------------------------- --spec info(pid()) -> {ok, {atom(), tuple()}} | {error, reason()}. -%% -%% Description: Returns ssl protocol and cipher used for the connection -%%-------------------------------------------------------------------- -info(ConnectionPid) -> - sync_send_all_state_event(ConnectionPid, info). - %%-------------------------------------------------------------------- -spec session_info(pid()) -> {ok, list()} | {error, reason()}. %% @@ -838,13 +830,6 @@ handle_sync_event({prf, Secret, Label, Seed, WantedLength}, _, StateName, error:Reason -> {error, Reason} end, {reply, Reply, StateName, State, get_timeout(State)}; -handle_sync_event(info, _, StateName, - #state{negotiated_version = Version, - session = #session{cipher_suite = Suite}} = State) -> - - AtomVersion = tls_record:protocol_version(Version), - {reply, {ok, {AtomVersion, ssl:suite_definition(Suite)}}, - StateName, State, get_timeout(State)}; handle_sync_event(session_info, _, StateName, #state{session = #session{session_id = Id, cipher_suite = Suite}} = State) -> @@ -855,8 +840,8 @@ handle_sync_event(peer_certificate, _, StateName, #state{session = #session{peer_certificate = Cert}} = State) -> {reply, {ok, Cert}, StateName, State, get_timeout(State)}; -handle_sync_event(sni_hostname, _, StateName, #state{sni_hostname = SNIHostname} = State) -> - {reply, SNIHostname, StateName, State}. +handle_sync_event(connection_information, _, StateName, #state{sni_hostname = SNIHostname, session = #session{cipher_suite = CipherSuite}, negotiated_version = Version} = State) -> + {reply, {ok, [{protocol, tls_record:protocol_version(Version)}, {cipher_suite, ssl:suite_definition(CipherSuite)}, {sni_hostname, SNIHostname}]}, StateName, State, get_timeout(State)}. handle_info({ErrorTag, Socket, econnaborted}, StateName, diff --git a/lib/stdlib/src/otp_internal.erl b/lib/stdlib/src/otp_internal.erl index 24721da187..0340015c35 100644 --- a/lib/stdlib/src/otp_internal.erl +++ b/lib/stdlib/src/otp_internal.erl @@ -631,6 +631,9 @@ obsolete_1(erl_lint, modify_line, 2) -> obsolete_1(ssl, negotiated_next_protocol, 1) -> {deprecated,{ssl,negotiated_protocol,1}}; +obsolete_1(ssl, connection_info, 1) -> + {deprecated, "deprecated; use connection_information/[1,2] instead"}; + obsolete_1(_, _, _) -> no. -- cgit v1.2.3 From 53ae813221c2dee502e2c114e68c2674c96b89cd Mon Sep 17 00:00:00 2001 From: Qijiang Fan Date: Tue, 30 Dec 2014 22:44:20 +0800 Subject: ssl: docs: SNI server, connection_information/1,2 --- lib/ssl/doc/src/ssl.xml | 47 +++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 45 insertions(+), 2 deletions(-) (limited to 'lib') diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index c4651d051c..77f63dcecf 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -106,7 +106,8 @@

| {client_preferred_next_protocols, {client | server, [binary()]} | {client | server, [binary()], binary()}}

| {log_alert, boolean()}

-

| {server_name_indication, hostname() | disable}

+

| {server_name_indication, hostname() | disable}

+

| {sni_hosts, [{hostname(), ssloptions()}]}

transportoption() = @@ -626,7 +627,10 @@ fun(srp, Username :: string(), UserState :: term()) -> selection. If set to false (the default), use the client preference.

- + {sni_hosts, [{hostname(), ssloptions()}]} +

If the server receives a SNI (Server Name Indication) from the client + matching a host listed in the sni_hosts option, the speicific options for + that host will override previously specified options.
@@ -753,6 +757,45 @@ fun(srp, Username :: string(), UserState :: term()) -> + + connection_information(SslSocket) -> + {ok, Info} | {error, Reason} + Returns all the connection information. + + + Info = [InfoTuple] + InfoTuple = {protocol, Protocol} | {cipher_suite, CipherSuite} | {sni_hostname, SNIHostname} + CipherSuite = ciphersuite() + ProtocolVersion = protocol() + SNIHostname = string() + Reason = term() + +

Return all the connection information containing negotiated protocol version, cipher suite, and the hostname of SNI extension. + Info will be a proplists containing all the connection information on success, otherwise {error, Reason} will be returned.

+ + + + + connection_information(SslSocket, Items) -> + {ok, Info} | {error, Reason} + Returns the requested connection information. + + + Items = [Item] + Item = protocol | cipher_suite | sni_hostname + Info = [InfoTuple] + InfoTuple = {protocol, Protocol} | {cipher_suite, CipherSuite} | {sni_hostname, SNIHostname} + CipherSuite = ciphersuite() + ProtocolVersion = protocol() + SNIHostname = string() + Reason = term() + +

Returns the connection information you requested. The connection information you can request contains protocol, cipher_suite, and sni_hostname. + {ok, Info} will be returned if it executes sucessfully. The Info is a proplists containing the information you requested. + Otherwise, {error, Reason} will be returned.

+ + + format_error(Reason) -> string() Returns an error string. -- cgit v1.2.3 From 181ceb12675b59de9bd7a881fe9b58995d03bac0 Mon Sep 17 00:00:00 2001 From: Qijiang Fan Date: Sat, 14 Mar 2015 16:58:30 +0800 Subject: ssl: add tests for SNI server support This commit adds tests for SNI server support in: * ssl_sni_SUITE.erl * ssl_to_openssl_SUITE.erl And some more modifications: * make_certs also makes two certs for SNI, and adds extra options for SNI. --- lib/ssl/test/Makefile | 1 + lib/ssl/test/make_certs.erl | 2 +- lib/ssl/test/ssl_sni_SUITE.erl | 136 ++++++++++++++++++++++++++++++++++ lib/ssl/test/ssl_test_lib.erl | 17 ++++- lib/ssl/test/ssl_to_openssl_SUITE.erl | 93 ++++++++++++++++++++++- 5 files changed, 244 insertions(+), 5 deletions(-) create mode 100644 lib/ssl/test/ssl_sni_SUITE.erl (limited to 'lib') diff --git a/lib/ssl/test/Makefile b/lib/ssl/test/Makefile index 8c45a788a4..886cc7726b 100644 --- a/lib/ssl/test/Makefile +++ b/lib/ssl/test/Makefile @@ -53,6 +53,7 @@ MODULES = \ ssl_to_openssl_SUITE \ ssl_ECC_SUITE \ ssl_upgrade_SUITE\ + ssl_sni_SUITE \ make_certs\ erl_make_certs diff --git a/lib/ssl/test/make_certs.erl b/lib/ssl/test/make_certs.erl index 77631f62d3..4a193d48fe 100644 --- a/lib/ssl/test/make_certs.erl +++ b/lib/ssl/test/make_certs.erl @@ -81,7 +81,7 @@ all(DataDir, PrivDir, C = #config{}) -> create_rnd(DataDir, PrivDir), % For all requests rootCA(PrivDir, "erlangCA", C), intermediateCA(PrivDir, "otpCA", "erlangCA", C), - endusers(PrivDir, "otpCA", ["client", "server", "revoked"], C), + endusers(PrivDir, "otpCA", ["client", "server", "revoked", "a.server", "b.server"], C), endusers(PrivDir, "erlangCA", ["localhost"], C), %% Create keycert files SDir = filename:join([PrivDir, "server"]), diff --git a/lib/ssl/test/ssl_sni_SUITE.erl b/lib/ssl/test/ssl_sni_SUITE.erl new file mode 100644 index 0000000000..134e508b10 --- /dev/null +++ b/lib/ssl/test/ssl_sni_SUITE.erl @@ -0,0 +1,136 @@ +%% +%% %CopyrightBegin% +%% +%% Copyright Ericsson AB 2008-2015. All Rights Reserved. +%% +%% The contents of this file are subject to the Erlang Public License, +%% Version 1.1, (the "License"); you may not use this file except in +%% compliance with the License. You should have received a copy of the +%% Erlang Public License along with this software. If not, it can be +%% retrieved online at http://www.erlang.org/. +%% +%% Software distributed under the License is distributed on an "AS IS" +%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +%% the License for the specific language governing rights and limitations +%% under the License. +%% +%% %CopyrightEnd% +%% + +%% + +-module(ssl_sni_SUITE). + +-compile(export_all). + +-include_lib("common_test/include/ct.hrl"). +-include_lib("public_key/include/public_key.hrl"). + +%%-------------------------------------------------------------------- +%% Common Test interface functions ----------------------------------- +%%-------------------------------------------------------------------- +suite() -> [{ct_hooks,[ts_install_cth]}]. + +all() -> [no_sni_header, sni_match, sni_no_match]. + +init_per_suite(Config0) -> + catch crypto:stop(), + try crypto:start() of + ok -> + ssl:start(), + Result = + (catch make_certs:all(?config(data_dir, Config0), + ?config(priv_dir, Config0))), + ct:log("Make certs ~p~n", [Result]), + ssl_test_lib:cert_options(Config0) + catch _:_ -> + {skip, "Crypto did not start"} + end. + +end_per_suite(_) -> + ssl:stop(), + application:stop(crypto). + +%%-------------------------------------------------------------------- +%% Test Cases -------------------------------------------------------- +%%-------------------------------------------------------------------- +no_sni_header(Config) -> + run_handshake(Config, undefined, undefined, "server"). + +sni_match(Config) -> + run_handshake(Config, "a.server", "a.server", "a.server"). + +sni_no_match(Config) -> + run_handshake(Config, "c.server", undefined, "server"). + + + +%%-------------------------------------------------------------------- +%% Internal Functions ------------------------------------------------ +%%-------------------------------------------------------------------- + + +ssl_recv(SSLSocket, Expect) -> + ssl_recv(SSLSocket, "", Expect). + +ssl_recv(SSLSocket, CurrentData, ExpectedData) -> + receive + {ssl, SSLSocket, Data} -> + NeweData = CurrentData ++ Data, + case NeweData of + ExpectedData -> + ok; + _ -> + ssl_recv(SSLSocket, NeweData, ExpectedData) + end; + Other -> + ct:fail({unexpected_message, Other}) + after 4000 -> + ct:fail({timeout, CurrentData, ExpectedData}) + end. + + + +send_and_hostname(SSLSocket) -> + ssl:send(SSLSocket, "OK"), + {ok, [{sni_hostname, Hostname}]} = ssl:connection_information(SSLSocket, [sni_hostname]), + Hostname. + +rdnPart([[#'AttributeTypeAndValue'{type=Type, value=Value} | _] | _], Type) -> Value; +rdnPart([_ | Tail], Type) -> rdnPart(Tail, Type); +rdnPart([], _) -> unknown. + +rdn_to_string({utf8String, Binary}) -> + erlang:binary_to_list(Binary); +rdn_to_string({printableString, String}) -> + String. + +recv_and_certificate(SSLSocket) -> + ssl_recv(SSLSocket, "OK"), + {ok, PeerCert} = ssl:peercert(SSLSocket), + #'OTPCertificate'{tbsCertificate = #'OTPTBSCertificate'{subject = {rdnSequence, Subject}}} = public_key:pkix_decode_cert(PeerCert, otp), + ct:log("Subject of certificate received from server: ~p", [Subject]), + rdn_to_string(rdnPart(Subject, ?'id-at-commonName')). + + +run_handshake(Config, SNIHostname, ExpectedSNIHostname, ExpectedCN) -> + ct:log("Start running handshake, Config: ~p, SNIHostname: ~p, ExpectedSNIHostname: ~p, ExpectedCN: ~p", [Config, SNIHostname, ExpectedSNIHostname, ExpectedCN]), + ServerOptions = ?config(sni_server_opts, Config) ++ ?config(server_opts, Config), + ClientOptions = + case SNIHostname of + undefined -> + ?config(client_opts, Config); + _ -> + [{server_name_indication, SNIHostname}] ++ ?config(client_opts, Config) + end, + ct:log("Options: ~p", [[ServerOptions, ClientOptions]]), + {ClientNode, ServerNode, Hostname} = ssl_test_lib:run_where(Config), + Server = ssl_test_lib:start_server([{node, ServerNode}, {port, 0}, + {from, self()}, {mfa, {?MODULE, send_and_hostname, []}}, + {options, ServerOptions}]), + Port = ssl_test_lib:inet_port(Server), + Client = ssl_test_lib:start_client([{node, ClientNode}, {port, Port}, + {host, Hostname}, {from, self()}, + {mfa, {?MODULE, recv_and_certificate, []}}, + {options, ClientOptions}]), + ssl_test_lib:check_result(Server, ExpectedSNIHostname, Client, ExpectedCN). diff --git a/lib/ssl/test/ssl_test_lib.erl b/lib/ssl/test/ssl_test_lib.erl index d19e3b7fdb..8b98e6f16b 100644 --- a/lib/ssl/test/ssl_test_lib.erl +++ b/lib/ssl/test/ssl_test_lib.erl @@ -354,6 +354,11 @@ cert_options(Config) -> BadKeyFile = filename:join([?config(priv_dir, Config), "badkey.pem"]), PskSharedSecret = <<1,2,3,4,5,6,7,8,9,10,11,12,13,14,15>>, + + SNIServerACertFile = filename:join([?config(priv_dir, Config), "a.server", "cert.pem"]), + SNIServerAKeyFile = filename:join([?config(priv_dir, Config), "a.server", "key.pem"]), + SNIServerBCertFile = filename:join([?config(priv_dir, Config), "b.server", "cert.pem"]), + SNIServerBKeyFile = filename:join([?config(priv_dir, Config), "b.server", "key.pem"]), [{client_opts, [{ssl_imp, new},{reuseaddr, true}]}, {client_verification_opts, [{cacertfile, ClientCaCertFile}, {certfile, ClientCertFile}, @@ -414,7 +419,17 @@ cert_options(Config) -> {server_bad_cert, [{ssl_imp, new},{cacertfile, ServerCaCertFile}, {certfile, BadCertFile}, {keyfile, ServerKeyFile}]}, {server_bad_key, [{ssl_imp, new},{cacertfile, ServerCaCertFile}, - {certfile, ServerCertFile}, {keyfile, BadKeyFile}]} + {certfile, ServerCertFile}, {keyfile, BadKeyFile}]}, + {sni_server_opts, [{sni_hosts, [ + {"a.server", [ + {certfile, SNIServerACertFile}, + {keyfile, SNIServerAKeyFile} + ]}, + {"b.server", [ + {certfile, SNIServerBCertFile}, + {keyfile, SNIServerBKeyFile} + ]} + ]}]} | Config]. diff --git a/lib/ssl/test/ssl_to_openssl_SUITE.erl b/lib/ssl/test/ssl_to_openssl_SUITE.erl index 94426a3061..3807a9983c 100644 --- a/lib/ssl/test/ssl_to_openssl_SUITE.erl +++ b/lib/ssl/test/ssl_to_openssl_SUITE.erl @@ -50,9 +50,9 @@ all() -> groups() -> [{basic, [], basic_tests()}, - {'tlsv1.2', [], all_versions_tests() ++ alpn_tests() ++ npn_tests()}, - {'tlsv1.1', [], all_versions_tests() ++ alpn_tests() ++ npn_tests()}, - {'tlsv1', [], all_versions_tests()++ alpn_tests() ++ npn_tests()}, + {'tlsv1.2', [], all_versions_tests() ++ alpn_tests() ++ npn_tests() ++ sni_server_tests()}, + {'tlsv1.1', [], all_versions_tests() ++ alpn_tests() ++ npn_tests() ++ sni_server_tests()}, + {'tlsv1', [], all_versions_tests()++ alpn_tests() ++ npn_tests() ++ sni_server_tests()}, {'sslv3', [], all_versions_tests()}]. basic_tests() -> @@ -101,6 +101,11 @@ npn_tests() -> erlang_client_openssl_server_npn_only_client, erlang_client_openssl_server_npn_only_server]. +sni_server_tests() -> + [erlang_server_oepnssl_client_sni_match, + erlang_server_openssl_client_sni_no_match, + erlang_server_openssl_client_sni_no_header]. + init_per_suite(Config0) -> Dog = ct:timetrap(?LONG_TIMEOUT *2), @@ -222,6 +227,12 @@ special_init(TestCase, Config) check_openssl_npn_support(Config) end; +special_init(TestCase, Config) + when TestCase == erlang_server_openssl_client_sni_match; + TestCase == erlang_server_openssl_client_sni_no_match; + TestCase == erlang_server_openssl_client_sni_no_header -> + check_openssl_sni_support(Config); + special_init(_, Config) -> Config. @@ -1181,6 +1192,16 @@ erlang_server_openssl_client_npn_only_client(Config) when is_list(Config) -> ssl_test_lib:check_result(Server, ok) end), ok. +%-------------------------------------------------------------------------- +erlang_server_openssl_client_sni_no_header(Config) when is_list(Config) -> + erlang_server_openssl_client_sni_test(Config, undefined, undefined, "server"). + +erlang_server_openssl_client_sni_match(Config) when is_list(Config) -> + erlang_server_openssl_client_sni_test(Config, "a.server", "a.server", "a.server"). + +erlang_server_openssl_client_sni_no_match(Config) when is_list(Config) -> + erlang_server_openssl_client_sni_test(Config, "c.server", undefined, "server"). + %%-------------------------------------------------------------------- %% Internal functions ------------------------------------------------ @@ -1207,6 +1228,64 @@ run_suites(Ciphers, Version, Config, Type) -> ct:fail(cipher_suite_failed_see_test_case_log) end. +client_read_check([], _NewData) -> ok; +client_read_check([Hd | T], NewData) -> + case binary:match(NewData, list_to_binary(Hd)) of + nomatch -> + nomatch; + _ -> + client_read_check(T, NewData) + end. +client_read_bulk(Port, DataExpected, DataReceived) -> + receive + {Port, {data, TheData}} -> + Data = list_to_binary(TheData), + NewData = <>, + ct:log("New Data: ~p", [NewData]), + case client_read_check(DataExpected, NewData) of + ok -> + ok; + _ -> + client_read_bulk(Port, DataExpected, NewData) + end; + _ -> + ct:fail("unexpected_message") + after 4000 -> + ct:fail("timeout") + end. +client_read_bulk(Port, DataExpected) -> + client_read_bulk(Port, DataExpected, <<"">>). + +send_and_hostname(SSLSocket) -> + ssl:send(SSLSocket, "OK"), + {ok, [{sni_hostname, Hostname}]} = ssl:connection_information(SSLSocket, [sni_hostname]), + Hostname. + +erlang_server_openssl_client_sni_test(Config, SNIHostname, ExpectedSNIHostname, ExpectedCN) -> + ct:log("Start running handshake, Config: ~p, SNIHostname: ~p, ExpectedSNIHostname: ~p, ExpectedCN: ~p", [Config, SNIHostname, ExpectedSNIHostname, ExpectedCN]), + ServerOptions = ?config(sni_server_opts, Config) ++ ?config(server_opts, Config), + {_, ServerNode, Hostname} = ssl_test_lib:run_where(Config), + Server = ssl_test_lib:start_server([{node, ServerNode}, {port, 0}, + {from, self()}, {mfa, {?MODULE, send_and_hostname, []}}, + {options, ServerOptions}]), + Port = ssl_test_lib:inet_port(Server), + ClientCommand = case SNIHostname of + undefined -> + "openssl s_client -connect " ++ Hostname ++ ":" ++ integer_to_list(Port); + _ -> + "openssl s_client -connect " ++ Hostname ++ ":" ++ integer_to_list(Port) ++ " -servername " ++ SNIHostname + end, + ct:log("Options: ~p", [[ServerOptions, ClientCommand]]), + ClientPort = open_port({spawn, ClientCommand}, [stderr_to_stdout]), + ssl_test_lib:check_result(Server, ExpectedSNIHostname), + ExpectedClientOutput = ["OK", "/CN=" ++ ExpectedCN ++ "/"], + ok = client_read_bulk(ClientPort, ExpectedClientOutput), + ssl_test_lib:close_port(ClientPort), + ssl_test_lib:close(Server), + ok. + + + cipher(CipherSuite, Version, Config, ClientOpts, ServerOpts) -> process_flag(trap_exit, true), ct:log("Testing CipherSuite ~p~n", [CipherSuite]), @@ -1588,6 +1667,14 @@ server_sent_garbage(Socket) -> end. +check_openssl_sni_support(Config) -> + HelpText = os:cmd("openssl s_client --help"), + case string:str(HelpText, "-servername") of + 0 -> + {skip, "Current openssl doesn't support SNI"}; + _ -> + Config + end. check_openssl_npn_support(Config) -> HelpText = os:cmd("openssl s_client --help"), -- cgit v1.2.3 From db509dd5debcd72d7f1d024d289315274f9b788b Mon Sep 17 00:00:00 2001 From: Qijiang Fan Date: Thu, 16 Apr 2015 22:25:57 +0800 Subject: ssl: add option sni_fun The newly added function sni_fun allows dynamic update of SSL options like keys and certificates depending on different SNI hostname, rather than a predefined rules of SSL options. --- lib/ssl/doc/src/ssl.xml | 21 +++++++++++++++- lib/ssl/src/ssl.erl | 19 ++++++++++++++- lib/ssl/src/ssl_internal.hrl | 1 + lib/ssl/src/tls_connection.erl | 20 +++++++++------ lib/ssl/test/ssl_sni_SUITE.erl | 34 +++++++++++++++++++++++++- lib/ssl/test/ssl_to_openssl_SUITE.erl | 46 ++++++++++++++++++++++++++++++++--- 6 files changed, 128 insertions(+), 13 deletions(-) (limited to 'lib') diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index 77f63dcecf..8a0bf69be4 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -108,10 +108,12 @@

| {log_alert, boolean()}

| {server_name_indication, hostname() | disable}

| {sni_hosts, [{hostname(), ssloptions()}]}

+

| {sni_fun, SNIfun::fun()}

transportoption() =

{cb_info, {CallbackModule::atom(), DataTag::atom(), + ClosedTag::atom(), ErrTag:atom()}}

Defaults to {gen_tcp, tcp, tcp_closed, tcp_error}. Can be used to customize the transport layer. The callback module must implement a @@ -185,6 +187,9 @@

srp_1024 | srp_1536 | srp_2048 | srp_3072 | srp_4096 | srp_6144 | srp_8192

 + SNIfun::fun() +

= fun(ServerName :: string()) -> ssloptions()

 +
@@ -630,7 +635,21 @@ fun(srp, Username :: string(), UserState :: term()) -> {sni_hosts, [{hostname(), ssloptions()}]}

If the server receives a SNI (Server Name Indication) from the client matching a host listed in the sni_hosts option, the speicific options for - that host will override previously specified options.

 + that host will override previously specified options. + + The option sni_fun, and sni_hosts are mutually exclusive.

+ + {sni_fun, SNIfun::fun()} +

If the server receives a SNI (Server Name Indication) from the client, + the given function will be called to retrive ssloptions() for indicated server. + These options will be merged into predefined ssloptions(). + + The function should be defined as: + fun(ServerName :: string()) -> ssloptions() + and can be specified as a fun or as named fun module:function/1 + + The option sni_fun, and sni_hosts are mutually exclusive.

 +
diff --git a/lib/ssl/src/ssl.erl b/lib/ssl/src/ssl.erl index 956c699c45..9f76612ee3 100644 --- a/lib/ssl/src/ssl.erl +++ b/lib/ssl/src/ssl.erl @@ -700,6 +700,7 @@ handle_options(Opts0) -> log_alert = handle_option(log_alert, Opts, true), server_name_indication = handle_option(server_name_indication, Opts, undefined), sni_hosts = handle_option(sni_hosts, Opts, []), + sni_fun = handle_option(sni_fun, Opts, {}), honor_cipher_order = handle_option(honor_cipher_order, Opts, false), protocol = proplists:get_value(protocol, Opts, tls), padding_check = proplists:get_value(padding_check, Opts, true), @@ -716,7 +717,7 @@ handle_options(Opts0) -> user_lookup_fun, psk_identity, srp_identity, ciphers, reuse_session, reuse_sessions, ssl_imp, cb_info, renegotiate_at, secure_renegotiate, hibernate_after, - erl_dist, alpn_advertised_protocols, sni_hosts, + erl_dist, alpn_advertised_protocols, sni_hosts, sni_fun, alpn_preferred_protocols, next_protocols_advertised, client_preferred_next_protocols, log_alert, server_name_indication, honor_cipher_order, padding_check, crl_check, crl_cache, @@ -733,6 +734,18 @@ handle_options(Opts0) -> inet_user = SockOpts, transport_info = CbInfo, connection_cb = ConnetionCb }}. +handle_option(sni_fun, Opts, Default) -> + OptFun = validate_option(sni_fun, + proplists:get_value(sni_fun, Opts, Default)), + OptHosts = proplists:get_value(sni_hosts, Opts, undefined), + case {OptFun, OptHosts} of + {Default, _} -> + Default; + {_, undefined} -> + OptFun; + _ -> + throw({error, {conflict_options, [sni_fun, sni_hosts]}}) + end; handle_option(OptionName, Opts, Default) -> validate_option(OptionName, proplists:get_value(OptionName, Opts, Default)). @@ -920,6 +933,10 @@ validate_option(sni_hosts, [{Hostname, SSLOptions} | Tail]) when is_list(Hostnam _ -> throw({error, {options, {sni_hosts, RecursiveSNIOptions}}}) end; +validate_option(sni_fun, {}) -> + {}; +validate_option(sni_fun, Fun) when is_function(Fun) -> + Fun; validate_option(honor_cipher_order, Value) when is_boolean(Value) -> Value; validate_option(padding_check, Value) when is_boolean(Value) -> diff --git a/lib/ssl/src/ssl_internal.hrl b/lib/ssl/src/ssl_internal.hrl index e285f48202..b6b4fc44df 100644 --- a/lib/ssl/src/ssl_internal.hrl +++ b/lib/ssl/src/ssl_internal.hrl @@ -123,6 +123,7 @@ log_alert :: boolean(), server_name_indication = undefined, sni_hosts :: [{inet:hostname(), [tuple()]}], + sni_fun :: function(), %% Should the server prefer its own cipher order over the one provided by %% the client? honor_cipher_order = false :: boolean(), diff --git a/lib/ssl/src/tls_connection.erl b/lib/ssl/src/tls_connection.erl index d804d7ad37..1ee47f28b1 100644 --- a/lib/ssl/src/tls_connection.erl +++ b/lib/ssl/src/tls_connection.erl @@ -400,12 +400,19 @@ initial_state(Role, Host, Port, Socket, {SSLOptions, SocketOptions, Tracker}, Us update_ssl_options_from_sni(OrigSSLOptions, SNIHostname) -> - case proplists:get_value(SNIHostname, OrigSSLOptions#ssl_options.sni_hosts) of - undefined -> - undefined; - SSLOption -> - ssl:handle_options(SSLOption, OrigSSLOptions) - end. + SSLOption = + case OrigSSLOptions#ssl_options.sni_fun of + {} -> + proplists:get_value(SNIHostname, OrigSSLOptions#ssl_options.sni_hosts); + SNIFun -> + SNIFun(SNIHostname) + end, + case SSLOption of + undefined -> + undefined; + _ -> + ssl:handle_options(SSLOption, OrigSSLOptions) + end. next_state(Current,_, #alert{} = Alert, #state{negotiated_version = Version} = State) -> handle_own_alert(Alert, Version, Current, State); @@ -454,7 +461,6 @@ next_state(Current, Next, #ssl_tls{type = ?HANDSHAKE, fragment = Data}, undefined -> State0; #sni{hostname = Hostname} -> - OrigSSLOptions = State0#state.ssl_options, NewOptions = update_ssl_options_from_sni(State0#state.ssl_options, Hostname), case NewOptions of undefined -> diff --git a/lib/ssl/test/ssl_sni_SUITE.erl b/lib/ssl/test/ssl_sni_SUITE.erl index 134e508b10..46cd644e4d 100644 --- a/lib/ssl/test/ssl_sni_SUITE.erl +++ b/lib/ssl/test/ssl_sni_SUITE.erl @@ -31,7 +31,7 @@ %%-------------------------------------------------------------------- suite() -> [{ct_hooks,[ts_install_cth]}]. -all() -> [no_sni_header, sni_match, sni_no_match]. +all() -> [no_sni_header, sni_match, sni_no_match] ++ [no_sni_header_fun, sni_match_fun, sni_no_match_fun]. init_per_suite(Config0) -> catch crypto:stop(), @@ -57,12 +57,20 @@ end_per_suite(_) -> no_sni_header(Config) -> run_handshake(Config, undefined, undefined, "server"). +no_sni_header_fun(Config) -> + run_sni_fun_handshake(Config, undefined, undefined, "server"). + sni_match(Config) -> run_handshake(Config, "a.server", "a.server", "a.server"). +sni_match_fun(Config) -> + run_sni_fun_handshake(Config, "a.server", "a.server", "a.server"). + sni_no_match(Config) -> run_handshake(Config, "c.server", undefined, "server"). +sni_no_match_fun(Config) -> + run_sni_fun_handshake(Config, "c.server", undefined, "server"). %%-------------------------------------------------------------------- @@ -112,6 +120,30 @@ recv_and_certificate(SSLSocket) -> ct:log("Subject of certificate received from server: ~p", [Subject]), rdn_to_string(rdnPart(Subject, ?'id-at-commonName')). +run_sni_fun_handshake(Config, SNIHostname, ExpectedSNIHostname, ExpectedCN) -> + ct:log("Start running handshake for sni_fun, Config: ~p, SNIHostname: ~p, ExpectedSNIHostname: ~p, ExpectedCN: ~p", [Config, SNIHostname, ExpectedSNIHostname, ExpectedCN]), + [{sni_hosts, ServerSNIConf}] = ?config(sni_server_opts, Config), + SNIFun = fun(Domain) -> proplists:get_value(Domain, ServerSNIConf, undefined) end, + ServerOptions = ?config(server_opts, Config) ++ [{sni_fun, SNIFun}], + ClientOptions = + case SNIHostname of + undefined -> + ?config(client_opts, Config); + _ -> + [{server_name_indication, SNIHostname}] ++ ?config(client_opts, Config) + end, + ct:log("Options: ~p", [[ServerOptions, ClientOptions]]), + {ClientNode, ServerNode, Hostname} = ssl_test_lib:run_where(Config), + Server = ssl_test_lib:start_server([{node, ServerNode}, {port, 0}, + {from, self()}, {mfa, {?MODULE, send_and_hostname, []}}, + {options, ServerOptions}]), + Port = ssl_test_lib:inet_port(Server), + Client = ssl_test_lib:start_client([{node, ClientNode}, {port, Port}, + {host, Hostname}, {from, self()}, + {mfa, {?MODULE, recv_and_certificate, []}}, + {options, ClientOptions}]), + ssl_test_lib:check_result(Server, ExpectedSNIHostname, Client, ExpectedCN). + run_handshake(Config, SNIHostname, ExpectedSNIHostname, ExpectedCN) -> ct:log("Start running handshake, Config: ~p, SNIHostname: ~p, ExpectedSNIHostname: ~p, ExpectedCN: ~p", [Config, SNIHostname, ExpectedSNIHostname, ExpectedCN]), diff --git a/lib/ssl/test/ssl_to_openssl_SUITE.erl b/lib/ssl/test/ssl_to_openssl_SUITE.erl index 3807a9983c..0413415e49 100644 --- a/lib/ssl/test/ssl_to_openssl_SUITE.erl +++ b/lib/ssl/test/ssl_to_openssl_SUITE.erl @@ -102,9 +102,12 @@ npn_tests() -> erlang_client_openssl_server_npn_only_server]. sni_server_tests() -> - [erlang_server_oepnssl_client_sni_match, + [erlang_server_openssl_client_sni_match, + erlang_server_openssl_client_sni_match_fun, erlang_server_openssl_client_sni_no_match, - erlang_server_openssl_client_sni_no_header]. + erlang_server_openssl_client_sni_no_match_fun, + erlang_server_openssl_client_sni_no_header, + erlang_server_openssl_client_sni_no_header_fun]. init_per_suite(Config0) -> @@ -230,7 +233,10 @@ special_init(TestCase, Config) special_init(TestCase, Config) when TestCase == erlang_server_openssl_client_sni_match; TestCase == erlang_server_openssl_client_sni_no_match; - TestCase == erlang_server_openssl_client_sni_no_header -> + TestCase == erlang_server_openssl_client_sni_no_header; + TestCase == erlang_server_openssl_client_sni_match_fun; + TestCase == erlang_server_openssl_client_sni_no_match_fun; + TestCase == erlang_server_openssl_client_sni_no_header_fun -> check_openssl_sni_support(Config); special_init(_, Config) -> @@ -1196,12 +1202,21 @@ erlang_server_openssl_client_npn_only_client(Config) when is_list(Config) -> erlang_server_openssl_client_sni_no_header(Config) when is_list(Config) -> erlang_server_openssl_client_sni_test(Config, undefined, undefined, "server"). +erlang_server_openssl_client_sni_no_header_fun(Config) when is_list(Config) -> + erlang_server_openssl_client_sni_test_sni_fun(Config, undefined, undefined, "server"). + erlang_server_openssl_client_sni_match(Config) when is_list(Config) -> erlang_server_openssl_client_sni_test(Config, "a.server", "a.server", "a.server"). +erlang_server_openssl_client_sni_match_fun(Config) when is_list(Config) -> + erlang_server_openssl_client_sni_test_sni_fun(Config, "a.server", "a.server", "a.server"). + erlang_server_openssl_client_sni_no_match(Config) when is_list(Config) -> erlang_server_openssl_client_sni_test(Config, "c.server", undefined, "server"). +erlang_server_openssl_client_sni_no_match_fun(Config) when is_list(Config) -> + erlang_server_openssl_client_sni_test_sni_fun(Config, "c.server", undefined, "server"). + %%-------------------------------------------------------------------- %% Internal functions ------------------------------------------------ @@ -1285,6 +1300,31 @@ erlang_server_openssl_client_sni_test(Config, SNIHostname, ExpectedSNIHostname, ok. +erlang_server_openssl_client_sni_test_sni_fun(Config, SNIHostname, ExpectedSNIHostname, ExpectedCN) -> + ct:log("Start running handshake for sni_fun, Config: ~p, SNIHostname: ~p, ExpectedSNIHostname: ~p, ExpectedCN: ~p", [Config, SNIHostname, ExpectedSNIHostname, ExpectedCN]), + [{sni_hosts, ServerSNIConf}] = ?config(sni_server_opts, Config), + SNIFun = fun(Domain) -> proplists:get_value(Domain, ServerSNIConf, undefined) end, + ServerOptions = ?config(server_opts, Config) ++ [{sni_fun, SNIFun}], + {_, ServerNode, Hostname} = ssl_test_lib:run_where(Config), + Server = ssl_test_lib:start_server([{node, ServerNode}, {port, 0}, + {from, self()}, {mfa, {?MODULE, send_and_hostname, []}}, + {options, ServerOptions}]), + Port = ssl_test_lib:inet_port(Server), + ClientCommand = case SNIHostname of + undefined -> + "openssl s_client -connect " ++ Hostname ++ ":" ++ integer_to_list(Port); + _ -> + "openssl s_client -connect " ++ Hostname ++ ":" ++ integer_to_list(Port) ++ " -servername " ++ SNIHostname + end, + ct:log("Options: ~p", [[ServerOptions, ClientCommand]]), + ClientPort = open_port({spawn, ClientCommand}, [stderr_to_stdout]), + ssl_test_lib:check_result(Server, ExpectedSNIHostname), + ExpectedClientOutput = ["OK", "/CN=" ++ ExpectedCN ++ "/"], + ok = client_read_bulk(ClientPort, ExpectedClientOutput), + ssl_test_lib:close_port(ClientPort), + ssl_test_lib:close(Server), + ok. + cipher(CipherSuite, Version, Config, ClientOpts, ServerOpts) -> process_flag(trap_exit, true), -- cgit v1.2.3 From ff2400d7b5b1b090e128bc537d7bdd94c6aad97e Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Tue, 5 May 2015 16:03:18 +0200 Subject: ssl: Refactored and corrected sni_fun handling Dialyzer warned about the incorrect match of Packets. Code was refactored and the problem avoided in the process. Dialyzer warned that the empty tuple is not a function as the contract said it should be. Changed the handling of the sni_fun default value to be undefined and added it to the contract. --- lib/ssl/src/ssl.erl | 6 +-- lib/ssl/src/ssl_internal.hrl | 2 +- lib/ssl/src/tls_connection.erl | 86 +++++++++++++++++++++--------------------- 3 files changed, 48 insertions(+), 46 deletions(-) (limited to 'lib') diff --git a/lib/ssl/src/ssl.erl b/lib/ssl/src/ssl.erl index 9f76612ee3..225a9be66f 100644 --- a/lib/ssl/src/ssl.erl +++ b/lib/ssl/src/ssl.erl @@ -700,7 +700,7 @@ handle_options(Opts0) -> log_alert = handle_option(log_alert, Opts, true), server_name_indication = handle_option(server_name_indication, Opts, undefined), sni_hosts = handle_option(sni_hosts, Opts, []), - sni_fun = handle_option(sni_fun, Opts, {}), + sni_fun = handle_option(sni_fun, Opts, undefined), honor_cipher_order = handle_option(honor_cipher_order, Opts, false), protocol = proplists:get_value(protocol, Opts, tls), padding_check = proplists:get_value(padding_check, Opts, true), @@ -933,8 +933,8 @@ validate_option(sni_hosts, [{Hostname, SSLOptions} | Tail]) when is_list(Hostnam _ -> throw({error, {options, {sni_hosts, RecursiveSNIOptions}}}) end; -validate_option(sni_fun, {}) -> - {}; +validate_option(sni_fun, undefined) -> + undefined; validate_option(sni_fun, Fun) when is_function(Fun) -> Fun; validate_option(honor_cipher_order, Value) when is_boolean(Value) -> diff --git a/lib/ssl/src/ssl_internal.hrl b/lib/ssl/src/ssl_internal.hrl index b6b4fc44df..baeae68bc4 100644 --- a/lib/ssl/src/ssl_internal.hrl +++ b/lib/ssl/src/ssl_internal.hrl @@ -123,7 +123,7 @@ log_alert :: boolean(), server_name_indication = undefined, sni_hosts :: [{inet:hostname(), [tuple()]}], - sni_fun :: function(), + sni_fun :: function() | undefined, %% Should the server prefer its own cipher order over the one provided by %% the client? honor_cipher_order = false :: boolean(), diff --git a/lib/ssl/src/tls_connection.erl b/lib/ssl/src/tls_connection.erl index 1ee47f28b1..3304ffcddb 100644 --- a/lib/ssl/src/tls_connection.erl +++ b/lib/ssl/src/tls_connection.erl @@ -401,12 +401,13 @@ initial_state(Role, Host, Port, Socket, {SSLOptions, SocketOptions, Tracker}, Us update_ssl_options_from_sni(OrigSSLOptions, SNIHostname) -> SSLOption = - case OrigSSLOptions#ssl_options.sni_fun of - {} -> - proplists:get_value(SNIHostname, OrigSSLOptions#ssl_options.sni_hosts); - SNIFun -> - SNIFun(SNIHostname) - end, + case OrigSSLOptions#ssl_options.sni_fun of + undefined -> + proplists:get_value(SNIHostname, + OrigSSLOptions#ssl_options.sni_hosts); + SNIFun -> + SNIFun(SNIHostname) + end, case SSLOption of undefined -> undefined; @@ -442,50 +443,22 @@ next_state(Current, Next, #ssl_tls{type = ?HANDSHAKE, fragment = Data}, %% This message should not be included in handshake %% message hashes. Already in negotiation so it will be ignored! ?MODULE:SName(Packet, State); - ({#client_hello{} = Packet, Raw}, {next_state, connection = SName, State}) -> + ({#client_hello{} = Packet, Raw}, {next_state, connection = SName, HState0}) -> + HState = handle_sni_extension(Packet, HState0), Version = Packet#client_hello.client_version, Hs0 = ssl_handshake:init_handshake_history(), Hs1 = ssl_handshake:update_handshake_history(Hs0, Raw), - ?MODULE:SName(Packet, State#state{tls_handshake_history=Hs1, - renegotiation = {true, peer}}); - ({Packet, Raw}, {next_state, SName, State = #state{tls_handshake_history=Hs0}}) -> + ?MODULE:SName(Packet, HState#state{tls_handshake_history=Hs1, + renegotiation = {true, peer}}); + ({Packet, Raw}, {next_state, SName, HState0 = #state{tls_handshake_history=Hs0}}) -> + HState = handle_sni_extension(Packet, HState0), Hs1 = ssl_handshake:update_handshake_history(Hs0, Raw), - ?MODULE:SName(Packet, State#state{tls_handshake_history=Hs1}); + ?MODULE:SName(Packet, HState#state{tls_handshake_history=Hs1}); (_, StopState) -> StopState end, try {Packets, Buf} = tls_handshake:get_tls_handshake(Version,Data,Buf0), - State1 = case Packets of - [{#client_hello{extensions=HelloExtensions} = ClientHello, _}] -> - case HelloExtensions#hello_extensions.sni of - undefined -> - State0; - #sni{hostname = Hostname} -> - NewOptions = update_ssl_options_from_sni(State0#state.ssl_options, Hostname), - case NewOptions of - undefined -> - State0; - _ -> - {ok, Ref, CertDbHandle, FileRefHandle, CacheHandle, CRLDbHandle, OwnCert, Key, DHParams} = - ssl_config:init(NewOptions, State0#state.role), - State0#state{ - session = State0#state.session#session{own_certificate = OwnCert}, - file_ref_db = FileRefHandle, - cert_db_ref = Ref, - cert_db = CertDbHandle, - crl_db = CRLDbHandle, - session_cache = CacheHandle, - private_key = Key, - diffie_hellman_params = DHParams, - ssl_options = NewOptions, - sni_hostname = Hostname - } - end - end; - _ -> - State0 - end, - State = State1#state{protocol_buffers = + State = State0#state{protocol_buffers = Buffers#protocol_buffers{tls_packets = Packets, tls_handshake_buffer = Buf}}, handle_tls_handshake(Handle, Next, State) @@ -1027,3 +1000,32 @@ convert_options_partial_chain(Options, up) -> list_to_tuple(Head ++ [{partial_chain, fun(_) -> unknown_ca end}] ++ Tail); convert_options_partial_chain(Options, down) -> list_to_tuple(proplists:delete(partial_chain, tuple_to_list(Options))). + +handle_sni_extension(#client_hello{extensions = HelloExtensions}, State0) -> + case HelloExtensions#hello_extensions.sni of + undefined -> + State0; + #sni{hostname = Hostname} -> + NewOptions = update_ssl_options_from_sni(State0#state.ssl_options, Hostname), + case NewOptions of + undefined -> + State0; + _ -> + {ok, Ref, CertDbHandle, FileRefHandle, CacheHandle, CRLDbHandle, OwnCert, Key, DHParams} = + ssl_config:init(NewOptions, State0#state.role), + State0#state{ + session = State0#state.session#session{own_certificate = OwnCert}, + file_ref_db = FileRefHandle, + cert_db_ref = Ref, + cert_db = CertDbHandle, + crl_db = CRLDbHandle, + session_cache = CacheHandle, + private_key = Key, + diffie_hellman_params = DHParams, + ssl_options = NewOptions, + sni_hostname = Hostname + } + end + end; +handle_sni_extension(_, State0) -> + State0. -- cgit v1.2.3 From b1e1dd967a4f929a239f8d26829304c03d43dcf9 Mon Sep 17 00:00:00 2001 From: Hans Nilsson Date: Tue, 12 May 2015 17:41:26 +0200 Subject: inets: reject negative content-length --- lib/inets/src/http_server/httpd_request.erl | 8 ++++++-- lib/inets/vsn.mk | 2 +- 2 files changed, 7 insertions(+), 3 deletions(-) (limited to 'lib') diff --git a/lib/inets/src/http_server/httpd_request.erl b/lib/inets/src/http_server/httpd_request.erl index 6985065c3e..3ff07616f9 100644 --- a/lib/inets/src/http_server/httpd_request.erl +++ b/lib/inets/src/http_server/httpd_request.erl @@ -417,8 +417,12 @@ check_header({"content-length", Value}, Maxsizes) -> case length(Value) =< MaxLen of true -> try - _ = list_to_integer(Value), - ok + list_to_integer(Value) + of + I when I>= 0 -> + ok; + _ -> + {error, {size_error, Max, 411, "negative content-length"}} catch _:_ -> {error, {size_error, Max, 411, "content-length not an integer"}} end; diff --git a/lib/inets/vsn.mk b/lib/inets/vsn.mk index e9ecb2632a..ecb84e447c 100644 --- a/lib/inets/vsn.mk +++ b/lib/inets/vsn.mk @@ -18,6 +18,6 @@ # %CopyrightEnd% APPLICATION = inets -INETS_VSN = 5.10.7 +INETS_VSN = 5.10.8 PRE_VSN = APP_VSN = "$(APPLICATION)-$(INETS_VSN)$(PRE_VSN)" -- cgit v1.2.3 From e09dd66dc4d89c62ddfd8c19791f9678d5d787c6 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Tue, 12 May 2015 18:18:55 +0200 Subject: Prepare release --- lib/asn1/doc/src/notes.xml | 17 +++ lib/asn1/vsn.mk | 2 +- lib/common_test/doc/src/notes.xml | 73 ++++++++++++ lib/compiler/doc/src/notes.xml | 88 ++++++++++++++ lib/compiler/vsn.mk | 2 +- lib/cosEvent/doc/src/notes.xml | 18 ++- lib/cosEventDomain/doc/src/notes.xml | 18 ++- lib/cosFileTransfer/doc/src/notes.xml | 18 ++- lib/cosNotification/doc/src/notes.xml | 18 ++- lib/cosProperty/doc/src/notes.xml | 18 ++- lib/cosTime/doc/src/notes.xml | 18 ++- lib/cosTransactions/doc/src/notes.xml | 18 ++- lib/crypto/doc/src/notes.xml | 43 +++++++ lib/crypto/vsn.mk | 2 +- lib/debugger/doc/src/notes.xml | 18 +++ lib/debugger/vsn.mk | 2 +- lib/dialyzer/doc/src/notes.xml | 86 ++++++++++++++ lib/dialyzer/vsn.mk | 2 +- lib/edoc/doc/src/notes.xml | 15 +++ lib/edoc/vsn.mk | 2 +- lib/eldap/doc/src/notes.xml | 16 +++ lib/eunit/doc/src/notes.xml | 14 +++ lib/eunit/vsn.mk | 2 +- lib/hipe/doc/src/notes.xml | 36 ++++++ lib/hipe/vsn.mk | 2 +- lib/inets/doc/src/notes.xml | 21 +++- lib/inets/vsn.mk | 2 +- lib/jinterface/doc/src/notes.xml | 53 +++++++++ lib/jinterface/vsn.mk | 2 +- lib/kernel/doc/src/notes.xml | 73 ++++++++++++ lib/kernel/vsn.mk | 2 +- lib/mnesia/doc/src/notes.xml | 32 ++++- lib/mnesia/vsn.mk | 2 +- lib/observer/doc/src/notes.xml | 22 ++++ lib/observer/vsn.mk | 2 +- lib/orber/doc/src/notes.xml | 18 ++- lib/os_mon/doc/src/notes.xml | 19 +++ lib/os_mon/vsn.mk | 2 +- lib/parsetools/doc/src/notes.xml | 15 +++ lib/parsetools/vsn.mk | 2 +- lib/percept/doc/src/notes.xml | 15 +++ lib/percept/vsn.mk | 2 +- lib/public_key/doc/src/notes.xml | 31 +++++ lib/sasl/doc/src/notes.xml | 24 ++++ lib/sasl/vsn.mk | 2 +- lib/ssh/doc/src/notes.xml | 66 ++++++++++ lib/ssl/doc/src/notes.xml | 63 +++++++++- lib/stdlib/doc/src/notes.xml | 218 ++++++++++++++++++++++++++++++++++ lib/stdlib/vsn.mk | 2 +- lib/syntax_tools/doc/src/notes.xml | 14 +++ lib/syntax_tools/vsn.mk | 2 +- lib/test_server/doc/src/notes.xml | 49 ++++++++ lib/tools/doc/src/notes.xml | 59 +++++++++ lib/tools/vsn.mk | 2 +- lib/typer/doc/src/notes.xml | 14 +++ lib/typer/vsn.mk | 2 +- lib/webtool/doc/src/notes.xml | 17 +++ lib/wx/doc/src/notes.xml | 49 ++++++++ lib/wx/vsn.mk | 2 +- lib/xmerl/doc/src/notes.xml | 14 +++ 60 files changed, 1429 insertions(+), 33 deletions(-) (limited to 'lib') diff --git a/lib/asn1/doc/src/notes.xml b/lib/asn1/doc/src/notes.xml index 9feb673c04..f73d21b9e3 100644 --- a/lib/asn1/doc/src/notes.xml +++ b/lib/asn1/doc/src/notes.xml @@ -31,6 +31,23 @@

This document describes the changes made to the asn1 application.

+
Asn1 4.0 + +
Fixed Bugs and Malfunctions + + +

+ Many bugs have been eliminated in the the ASN.1 compiler + so that it can now successfully compile many more ASN.1 + specifications. Error messages have also been improved.

+

+ Own Id: OTP-12395

+ + +
+ +
+
Asn1 3.0.4
Fixed Bugs and Malfunctions diff --git a/lib/asn1/vsn.mk b/lib/asn1/vsn.mk index c909c908d6..d4c46863a3 100644 --- a/lib/asn1/vsn.mk +++ b/lib/asn1/vsn.mk @@ -1 +1 @@ -ASN1_VSN = 3.0.4 +ASN1_VSN = 4.0 diff --git a/lib/common_test/doc/src/notes.xml b/lib/common_test/doc/src/notes.xml index 472e3b7833..218f76d403 100644 --- a/lib/common_test/doc/src/notes.xml +++ b/lib/common_test/doc/src/notes.xml @@ -32,6 +32,79 @@ notes.xml +
Common_Test 1.11 + +
Fixed Bugs and Malfunctions + + +

+ The status of an aborted test due to test suite + compilation error has changed from 'auto_skipped' to + 'failed'. This affects both the textual log file, event + handling and CT hook callbacks. The logging of + compilation failures has also been improved, especially + in the case of multiple test suites failing compilation.

+

+ Own Id: OTP-10816

+ + +
+ + +
Improvements and New Features + + +

+ Earlier there was no way to add optional parameters like + default-operation to an edit-config request sent with + ct_netconfc:edit_config/3,4, you had to use + ct_netconfc:send_rpc/2,3. For simplicity and completion, + a new optional argument, OptParams, is now added to the + edit_config function.

+

+ Own Id: OTP-10446 Aux Id: kunagi-266 [177]

+ + +

+ When running OTP tests using the ts interface, it is now + possible to specify so called test categories per OTP + application. A test category is represented by a CT test + specification and defines an arbitrary subset of existing + test suites, groups and cases. Examples of test + categories are 'smoke' (smoke tests) and 'bench' + (benchmarks). (Call ts:help() for more info). Also, + functions for reading terms from the current test + specification during test, ct:get_testspec_terms/0 and + ct:get_testspec_terms/1, have been implemented.

+

+ Own Id: OTP-11962

+ + +

+ Obsolete scripts and make file operations have been + removed and the installation chapter in the Common Test + User's Guide has been updated.

+

+ Own Id: OTP-12421

+ + +

+ The 'keep_alive' interval has been reduced to 8 seconds, + which is two seconds shorter than the default + 'idle_timeout' value for ct_telnet:expect/3. This way, + the telnet server receives a NOP message (which might + trigger an action) before the operation times out. Also + the TCP option 'nodelay' has been enabled per default for + all telnet connections, in order to reduce the risk for + communication timeouts.

+

+ Own Id: OTP-12678 Aux Id: seq12818

+ + +
+ +
+
Common_Test 1.10.1
Fixed Bugs and Malfunctions diff --git a/lib/compiler/doc/src/notes.xml b/lib/compiler/doc/src/notes.xml index 9b5b44f3e1..0654738247 100644 --- a/lib/compiler/doc/src/notes.xml +++ b/lib/compiler/doc/src/notes.xml @@ -31,6 +31,94 @@

This document describes the changes made to the Compiler application.

+
Compiler 6.0 + +
Fixed Bugs and Malfunctions + + +

+ The compiler optimizes away building of terms that are + never actually used. As a result, the compiler in OTP 18 + may produce more warnings for terms that are built but + not used than the compiler in OTP 17.

+

+ Own Id: OTP-12453

+ + +

+ Using a map could incorrectly suppress warnings for + unused variables.

+

+ Own Id: OTP-12515

+ + +

+ The compiler now properly reports unknown parse + transforms. That is, undef exceptions coming from + the parse transform itself is reported differently from + the absence of the parse transform.

+

+ Own Id: OTP-12723

+ + +
+ + +
Improvements and New Features + + +

+ The cerl and cerl_trees modules in the + compiler application are now documented.

+

+ Own Id: OTP-11978

+ + +

+ The deprecated 'asm' option has been removed.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-12100

+ + +

+ Support variables as Map keys in expressions and patterns

+

Erlang will accept any expression as keys in Map + expressions and it will accept literals or bound + variables as keys in Map patterns.

+

+ Own Id: OTP-12218

+ + +

+ Infer Map type information in beam_type compiler + optimization pass.

+

+ Own Id: OTP-12253

+ + +

+ Compiler optimizations have been improved.

+

+ Own Id: OTP-12393

+ + +

+ Five undocumented functions in the module core_lib + have been deprecated and will be removed in the next + major release. The functions are: get_anno/{1,2}, + is_literal/1, is_literal_list/1, and + literal_value. Use the appropriate functions in + the cerl module instead.

+

+ Own Id: OTP-12497

+ + +
+ +
+
Compiler 5.0.4
Fixed Bugs and Malfunctions diff --git a/lib/compiler/vsn.mk b/lib/compiler/vsn.mk index 05e682c893..69f71ba5dd 100644 --- a/lib/compiler/vsn.mk +++ b/lib/compiler/vsn.mk @@ -1 +1 @@ -COMPILER_VSN = 5.0.4 +COMPILER_VSN = 6.0 diff --git a/lib/cosEvent/doc/src/notes.xml b/lib/cosEvent/doc/src/notes.xml index 8f519447fc..229e0c9945 100644 --- a/lib/cosEvent/doc/src/notes.xml +++ b/lib/cosEvent/doc/src/notes.xml @@ -32,7 +32,23 @@ notes.xml -
cosEvent 2.1.15 +
cosEvent 2.2 + +
Improvements and New Features + + +

Remove the usage of erlang:now() from all Corba + applications and use the new rand module instead of + random.

+

+ Own Id: OTP-12687

+ + +
+ +
+ +
cosEvent 2.1.15
Improvements and New Features diff --git a/lib/cosEventDomain/doc/src/notes.xml b/lib/cosEventDomain/doc/src/notes.xml index 2c3bf16411..72408b52f4 100644 --- a/lib/cosEventDomain/doc/src/notes.xml +++ b/lib/cosEventDomain/doc/src/notes.xml @@ -31,7 +31,23 @@ notes.xml -
cosEventDomain 1.1.14 +
cosEventDomain 1.2 + +
Improvements and New Features + + +

Remove the usage of erlang:now() from all Corba + applications and use the new rand module instead of + random.

+

+ Own Id: OTP-12687

+ + +
+ +
+ +
cosEventDomain 1.1.14
Improvements and New Features diff --git a/lib/cosFileTransfer/doc/src/notes.xml b/lib/cosFileTransfer/doc/src/notes.xml index 1d0c826d40..a3cce2a7d8 100644 --- a/lib/cosFileTransfer/doc/src/notes.xml +++ b/lib/cosFileTransfer/doc/src/notes.xml @@ -30,7 +30,23 @@ notes.xml -
cosFileTransfer 1.1.16 +
cosFileTransfer 1.2 + +
Improvements and New Features + + +

Remove the usage of erlang:now() from all Corba + applications and use the new rand module instead of + random.

+

+ Own Id: OTP-12687

+ + +
+ +
+ +
cosFileTransfer 1.1.16
Improvements and New Features diff --git a/lib/cosNotification/doc/src/notes.xml b/lib/cosNotification/doc/src/notes.xml index 2e4f922142..b16571a1cf 100644 --- a/lib/cosNotification/doc/src/notes.xml +++ b/lib/cosNotification/doc/src/notes.xml @@ -31,7 +31,23 @@ notes.xml -
cosNotification 1.1.21 +
cosNotification 1.2 + +
Improvements and New Features + + +

Remove the usage of erlang:now() from all Corba + applications and use the new rand module instead of + random.

+

+ Own Id: OTP-12687

+ + +
+ +
+ +
cosNotification 1.1.21
Improvements and New Features diff --git a/lib/cosProperty/doc/src/notes.xml b/lib/cosProperty/doc/src/notes.xml index 739f41617f..1885a8fd6b 100644 --- a/lib/cosProperty/doc/src/notes.xml +++ b/lib/cosProperty/doc/src/notes.xml @@ -31,7 +31,23 @@ notes.xml -
cosProperty 1.1.17 +
cosProperty 1.2 + +
Improvements and New Features + + +

Remove the usage of erlang:now() from all Corba + applications and use the new rand module instead of + random.

+

+ Own Id: OTP-12687

+ + +
+ +
+ +
cosProperty 1.1.17
Improvements and New Features diff --git a/lib/cosTime/doc/src/notes.xml b/lib/cosTime/doc/src/notes.xml index f218f19a6b..6c948c8c2b 100644 --- a/lib/cosTime/doc/src/notes.xml +++ b/lib/cosTime/doc/src/notes.xml @@ -32,7 +32,23 @@ notes.xml -
cosTime 1.1.14 +
cosTime 1.2 + +
Improvements and New Features + + +

Remove the usage of erlang:now() from all Corba + applications and use the new rand module instead of + random.

+

+ Own Id: OTP-12687

+ + +
+ +
+ +
cosTime 1.1.14
Improvements and New Features diff --git a/lib/cosTransactions/doc/src/notes.xml b/lib/cosTransactions/doc/src/notes.xml index 4b20f23efb..ae3b9eb6f2 100644 --- a/lib/cosTransactions/doc/src/notes.xml +++ b/lib/cosTransactions/doc/src/notes.xml @@ -32,7 +32,23 @@ notes.xml -
cosTransactions 1.2.14 +
cosTransactions 1.3 + +
Improvements and New Features + + +

Remove the usage of erlang:now() from all Corba + applications and use the new rand module instead of + random.

+

+ Own Id: OTP-12687

+ + +
+ +
+ +
cosTransactions 1.2.14
Improvements and New Features diff --git a/lib/crypto/doc/src/notes.xml b/lib/crypto/doc/src/notes.xml index a0ebc4b3dd..6ab109e349 100644 --- a/lib/crypto/doc/src/notes.xml +++ b/lib/crypto/doc/src/notes.xml @@ -30,6 +30,49 @@

This document describes the changes made to the Crypto application.

+
Crypto 3.6 + +
Fixed Bugs and Malfunctions + + +

+ Enhance crypto:generate_key to calculate ECC public keys + from private key.

+

+ Own Id: OTP-12394

+ + +

+ Fix bug in crypto:generate_key for ecdh + that could cause VM crash for faulty input.

+

+ Own Id: OTP-12733

+ + +
+ + +
Improvements and New Features + + +

+ Use the EVP API for AES-CBC crypto to enables the use of + hardware acceleration for AES-CBC crypto on newer Intel + CPUs (AES-NI), among other platforms.

+

+ Own Id: OTP-12380

+ + +

+ Add AES ECB block encryption.

+

+ Own Id: OTP-12403

+ + +
+ +
+
Crypto 3.5
Improvements and New Features diff --git a/lib/crypto/vsn.mk b/lib/crypto/vsn.mk index 8489b59562..55b1b3e8c4 100644 --- a/lib/crypto/vsn.mk +++ b/lib/crypto/vsn.mk @@ -1 +1 @@ -CRYPTO_VSN = 3.5 +CRYPTO_VSN = 3.6 diff --git a/lib/debugger/doc/src/notes.xml b/lib/debugger/doc/src/notes.xml index 7384189a6f..2bf80597b5 100644 --- a/lib/debugger/doc/src/notes.xml +++ b/lib/debugger/doc/src/notes.xml @@ -32,6 +32,24 @@

This document describes the changes made to the Debugger application.

+
Debugger 4.1 + +
Improvements and New Features + + +

+ Support variables as Map keys in expressions and patterns

+

Erlang will accept any expression as keys in Map + expressions and it will accept literals or bound + variables as keys in Map patterns.

+

+ Own Id: OTP-12218

+ + +
+ +
+
Debugger 4.0.3
Fixed Bugs and Malfunctions diff --git a/lib/debugger/vsn.mk b/lib/debugger/vsn.mk index b82f0f4e37..b6fd4e8e44 100644 --- a/lib/debugger/vsn.mk +++ b/lib/debugger/vsn.mk @@ -1 +1 @@ -DEBUGGER_VSN = 4.0.3 +DEBUGGER_VSN = 4.1 diff --git a/lib/dialyzer/doc/src/notes.xml b/lib/dialyzer/doc/src/notes.xml index 8976679c1d..d30882b5b9 100644 --- a/lib/dialyzer/doc/src/notes.xml +++ b/lib/dialyzer/doc/src/notes.xml @@ -31,6 +31,92 @@

This document describes the changes made to the Dialyzer application.

+
Dialyzer 2.8 + +
Fixed Bugs and Malfunctions + + +

The translation of Erlang forms to the type + representation used by Dialyzer has been improved in + several ways. The most important change is that deeply + nested records can be handled.

+

+ Own Id: OTP-12350

+ + +

Update the PLT properly when a module is changed. + (Thanks to James Fish for the bug report, and to Stavros + Aronis for fixing the bug.)

+

+ Own Id: OTP-12637

+ + +

+ An argument of '*'/2 is not constraind if the other + operand can be zero.

+

+ Own Id: OTP-12725

+ + +
+ + +
Improvements and New Features + + +

The -dialyzer() attribute can be used for + suppressing warnings in a module by specifying functions + or warning options. It can also be used for requesting + warnings in a module.

+

+ Own Id: OTP-10280

+ + +

The pre-defined types array(), dict(), + digraph(), gb_set(), gb_tree(), + queue(), set(), and tid() have been + removed.

+

+ Own Id: OTP-11445 Aux Id: OTP-10342, OTP-9352

+ + +

A few type names that have been used for representing + certain predefined types can now be used for user-defined + types. This affects the types product/_, + union/_, and range/2 as well as + tuple/N (N > 0), map/N (N > 0), + atom/1, integer/1, binary/2, + record/_, and 'fun'/_. A consequence is + that, for example, it is no longer possible to refer to a + record type with record(r); instead the usual + record notation, #r{}, is to be used.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-11851

+ + +

When implementing user-defined behaviours it is now + possible to specify optional callback functions. See OTP + Design Principles User's Guide, Sys and Proc_Lib, + User-Defined Behaviours, for details.

+

+ Own Id: OTP-11861

+ + +

Add two options to the Dialyzer: + no_missing_calls suppresses warnings about calls + to missing or unexported functions; unknown lets + warnings about unknown functions or types affect the exit + status. See also dialyzer(3).

+

+ Own Id: OTP-12682

+ + +
+ +
+
Dialyzer 2.7.4
Fixed Bugs and Malfunctions diff --git a/lib/dialyzer/vsn.mk b/lib/dialyzer/vsn.mk index 527afaf4ef..48e0830109 100644 --- a/lib/dialyzer/vsn.mk +++ b/lib/dialyzer/vsn.mk @@ -1 +1 @@ -DIALYZER_VSN = 2.7.4 +DIALYZER_VSN = 2.8 diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index e350adb540..48bb415ab3 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -31,6 +31,21 @@

This document describes the changes made to the EDoc application.

+
Edoc 0.7.17 + +
Improvements and New Features + + +

+ Remove functionality related to packages

+

+ Own Id: OTP-12431

+ + +
+ +
+
Edoc 0.7.16
Fixed Bugs and Malfunctions diff --git a/lib/edoc/vsn.mk b/lib/edoc/vsn.mk index 24cfbf16d5..49a73331c6 100644 --- a/lib/edoc/vsn.mk +++ b/lib/edoc/vsn.mk @@ -1 +1 @@ -EDOC_VSN = 0.7.16 +EDOC_VSN = 0.7.17 diff --git a/lib/eldap/doc/src/notes.xml b/lib/eldap/doc/src/notes.xml index e76101c30e..a7aefefb4a 100644 --- a/lib/eldap/doc/src/notes.xml +++ b/lib/eldap/doc/src/notes.xml @@ -30,6 +30,22 @@

This document describes the changes made to the Eldap application.

+
Eldap 1.2 + +
Improvements and New Features + + +

+ Support added for LDAP Password Modify Extended Operation + (RFC 3062). Thanks to danielwhite.

+

+ Own Id: OTP-12282

+ + +
+ +
+
Eldap 1.1.1
Fixed Bugs and Malfunctions diff --git a/lib/eunit/doc/src/notes.xml b/lib/eunit/doc/src/notes.xml index 6b76e097b6..3c6daf142e 100644 --- a/lib/eunit/doc/src/notes.xml +++ b/lib/eunit/doc/src/notes.xml @@ -32,6 +32,20 @@

This document describes the changes made to the EUnit application.

+
Eunit 2.2.10 + +
Fixed Bugs and Malfunctions + + +

The eunit application is now unicode safe.

+

+ Own Id: OTP-11660

+ + +
+ +
+
Eunit 2.2.9
Fixed Bugs and Malfunctions diff --git a/lib/eunit/vsn.mk b/lib/eunit/vsn.mk index dca8b3ece0..8b489bdc04 100644 --- a/lib/eunit/vsn.mk +++ b/lib/eunit/vsn.mk @@ -1 +1 @@ -EUNIT_VSN = 2.2.9 +EUNIT_VSN = 2.2.10 diff --git a/lib/hipe/doc/src/notes.xml b/lib/hipe/doc/src/notes.xml index 8d3358533b..1cc8558fe8 100644 --- a/lib/hipe/doc/src/notes.xml +++ b/lib/hipe/doc/src/notes.xml @@ -30,6 +30,42 @@

This document describes the changes made to HiPE.

+
Hipe 3.12 + +
Fixed Bugs and Malfunctions + + +

Fix a minor bug in the handling of opaque types.

+

+ Own Id: OTP-12666

+ + +

+ Fix hipe bug when matching a "writable" binary. The bug + has been seen to sometimes cause a failed binary matching + of a correct utf8 character, but other symptoms are also + possible.

+

+ Own Id: OTP-12667

+ + +
+ + +
Improvements and New Features + + +

+ Improved error handling when memory allocation for HiPE + code fails.

+

+ Own Id: OTP-12448

+ + +
+ +
+
Hipe 3.11.3
Fixed Bugs and Malfunctions diff --git a/lib/hipe/vsn.mk b/lib/hipe/vsn.mk index 60b4e0559b..e507ae933f 100644 --- a/lib/hipe/vsn.mk +++ b/lib/hipe/vsn.mk @@ -1 +1 @@ -HIPE_VSN = 3.11.3 +HIPE_VSN = 3.12 diff --git a/lib/inets/doc/src/notes.xml b/lib/inets/doc/src/notes.xml index 12bbc2b736..7939787601 100644 --- a/lib/inets/doc/src/notes.xml +++ b/lib/inets/doc/src/notes.xml @@ -32,7 +32,26 @@ notes.xml -
Inets 5.10.7 +
Inets 6.0 + +
Improvements and New Features + + +

+ Remove Server Side Include support from inets, as this is + an old technic that has security issues and was not well + tested.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-12156

+ + +
+ +
+ +
Inets 5.10.7
Improvements and New Features diff --git a/lib/inets/vsn.mk b/lib/inets/vsn.mk index e9ecb2632a..d5cb460404 100644 --- a/lib/inets/vsn.mk +++ b/lib/inets/vsn.mk @@ -18,6 +18,6 @@ # %CopyrightEnd% APPLICATION = inets -INETS_VSN = 5.10.7 +INETS_VSN = 6.0 PRE_VSN = APP_VSN = "$(APPLICATION)-$(INETS_VSN)$(PRE_VSN)" diff --git a/lib/jinterface/doc/src/notes.xml b/lib/jinterface/doc/src/notes.xml index fc5f8be53e..f854fa1f3a 100644 --- a/lib/jinterface/doc/src/notes.xml +++ b/lib/jinterface/doc/src/notes.xml @@ -30,6 +30,59 @@

This document describes the changes made to the Jinterface application.

+
Jinterface 1.6 + +
Fixed Bugs and Malfunctions + + +

+ Reformat the sources for JInterface uniformly and + according to the standard Java style guidelines. Provide + description of the rules applied in Eclipse format (for + other editors one can check the settings against these).

+

+ In short, the formatting style is: * indentation uses + only spaces; each level is 4 positions * no trailing + whitespace * mostly default Java style formatting (any + difference is minor) * always use {} blocks * use 'final' + as much as possible

+

+ Own Id: OTP-12333

+ + +
+ + +
Improvements and New Features + + +

+ Add basic transport factory implementation. This makes + possible creating connections between nodes using ssh + channels for example.

+

+ Own Id: OTP-12686

+ + +

+ Add Jinterface generic match and bind methods to provide + low level interface base methods sufficient for variety + of higher level pattern matching/variable binding + implementations.

+

+ Own Id: OTP-12691

+ + +

+ Minimal Java version is now 1.6

+

+ Own Id: OTP-12718

+ + +
+ +
+
Jinterface 1.5.12
Fixed Bugs and Malfunctions diff --git a/lib/jinterface/vsn.mk b/lib/jinterface/vsn.mk index 72ad316333..4df01d1151 100644 --- a/lib/jinterface/vsn.mk +++ b/lib/jinterface/vsn.mk @@ -1 +1 @@ -JINTERFACE_VSN = 1.5.12 +JINTERFACE_VSN = 1.6 diff --git a/lib/kernel/doc/src/notes.xml b/lib/kernel/doc/src/notes.xml index 6f7f18a8e7..0bd9a067ca 100644 --- a/lib/kernel/doc/src/notes.xml +++ b/lib/kernel/doc/src/notes.xml @@ -30,6 +30,79 @@

This document describes the changes made to the Kernel application.

+
Kernel 4.0 + +
Fixed Bugs and Malfunctions + + +

+ Fix error handling in file:read_line/1 for Unicode + contents.

+

+ Own Id: OTP-12144

+ + +

+ Introduce os:getenv/2 which is similar to + os:getenv/1 but returns the passed default value + if the required environment variable is undefined.

+

+ Own Id: OTP-12342

+ + +

+ It is now possible to paste text in JCL mode (using + Ctrl-Y) that has been copied in the previous shell + session. Also a bug that caused the JCL mode to crash + when pasting text has been fixed.

+

+ Own Id: OTP-12673

+ + +
+ + +
Improvements and New Features + + +

+ New BIF: erlang:get_keys/0, lists all keys + associated with the process dictionary. Note: + erlang:get_keys/0 is auto-imported.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-12151 Aux Id: seq12521

+ + +

+ The internal group to user_drv protocol has been changed + to be synchronous in order to guarantee that output sent + to a process implementing the user_drv protocol is + printed before replying. This protocol is used by the + standard_output device and the ssh application when + acting as a client.

+

+ This change changes the previous unlimited buffer when + printing to standard_io and other devices that end up in + user_drv to 1KB.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-12240

+ + +

The inflateInit/2 and deflateInit/6 + functions now accepts a WindowBits argument equal to 8 + and -8.

+

+ Own Id: OTP-12564

+ + +
+ +
+
Kernel 3.2
Fixed Bugs and Malfunctions diff --git a/lib/kernel/vsn.mk b/lib/kernel/vsn.mk index e1d447a465..c912da0091 100644 --- a/lib/kernel/vsn.mk +++ b/lib/kernel/vsn.mk @@ -1 +1 @@ -KERNEL_VSN = 3.2 +KERNEL_VSN = 4.0 diff --git a/lib/mnesia/doc/src/notes.xml b/lib/mnesia/doc/src/notes.xml index dc98efbff3..7f6ff1e655 100644 --- a/lib/mnesia/doc/src/notes.xml +++ b/lib/mnesia/doc/src/notes.xml @@ -38,7 +38,37 @@ thus constitutes one section in this document. The title of each section is the version number of Mnesia.

-
Mnesia 4.12.5 +
Mnesia 4.13 + +
Fixed Bugs and Malfunctions + + +

+ Mnesia's dirty functions did not always exit with + {aborted, Reason} as documented when an error + occurred.

+

+ Own Id: OTP-12714

+ + +
+ + +
Improvements and New Features + + +

+ Make Mnesia DCD dump behavior at start up optional, when + turned off mnesia loads large disc_copies tables faster.

+

+ Own Id: OTP-12481

+ + +
+ +
+ +
Mnesia 4.12.5
Fixed Bugs and Malfunctions diff --git a/lib/mnesia/vsn.mk b/lib/mnesia/vsn.mk index b23339e408..79dd495c4b 100644 --- a/lib/mnesia/vsn.mk +++ b/lib/mnesia/vsn.mk @@ -1 +1 @@ -MNESIA_VSN = 4.12.5 +MNESIA_VSN = 4.13 diff --git a/lib/observer/doc/src/notes.xml b/lib/observer/doc/src/notes.xml index a9ec68fc9e..338708db43 100644 --- a/lib/observer/doc/src/notes.xml +++ b/lib/observer/doc/src/notes.xml @@ -31,6 +31,28 @@

This document describes the changes made to the Observer application.

+
Observer 2.1 + +
Improvements and New Features + + +

+ Added the possibility to view sasl log entries for + processes.

+

+ Own Id: OTP-12504

+ + +

+ Add memory allocator usage and utilization graphs.

+

+ Own Id: OTP-12631

+ + +
+ +
+
Observer 2.0.4
Fixed Bugs and Malfunctions diff --git a/lib/observer/vsn.mk b/lib/observer/vsn.mk index 10ed3bdfe5..7e7e32099b 100644 --- a/lib/observer/vsn.mk +++ b/lib/observer/vsn.mk @@ -1 +1 @@ -OBSERVER_VSN = 2.0.4 +OBSERVER_VSN = 2.1 diff --git a/lib/orber/doc/src/notes.xml b/lib/orber/doc/src/notes.xml index 2167a43eee..1ffd86a1fb 100644 --- a/lib/orber/doc/src/notes.xml +++ b/lib/orber/doc/src/notes.xml @@ -33,7 +33,23 @@ -
Orber 3.7.1 +
Orber 3.8 + +
Improvements and New Features + + +

Remove the usage of erlang:now() from all Corba + applications and use the new rand module instead of + random.

+

+ Own Id: OTP-12687

+ + +
+ +
+ +
Orber 3.7.1
Fixed Bugs and Malfunctions diff --git a/lib/os_mon/doc/src/notes.xml b/lib/os_mon/doc/src/notes.xml index d3acc1effc..bd4206d748 100644 --- a/lib/os_mon/doc/src/notes.xml +++ b/lib/os_mon/doc/src/notes.xml @@ -30,6 +30,25 @@

This document describes the changes made to the OS_Mon application.

+
Os_Mon 2.4 + +
Improvements and New Features + + +

+ cpu_sup should use native sysctl/libkvm calls on BSD

+

+ This avoids forking off with os:cmd every time we just + want to collect the load averages. riak does this every + second, which results in a lot of unnecessary load.

+

+ Own Id: OTP-12730

+ + +
+ +
+
Os_Mon 2.3.1
Fixed Bugs and Malfunctions diff --git a/lib/os_mon/vsn.mk b/lib/os_mon/vsn.mk index 833e855e0e..7f2667e40a 100644 --- a/lib/os_mon/vsn.mk +++ b/lib/os_mon/vsn.mk @@ -1 +1 @@ -OS_MON_VSN = 2.3.1 +OS_MON_VSN = 2.4 diff --git a/lib/parsetools/doc/src/notes.xml b/lib/parsetools/doc/src/notes.xml index c8cb70b6d2..1751238d20 100644 --- a/lib/parsetools/doc/src/notes.xml +++ b/lib/parsetools/doc/src/notes.xml @@ -30,6 +30,21 @@

This document describes the changes made to the Parsetools application.

+
Parsetools 2.1 + +
Improvements and New Features + + +

The new -dialyzer() attribute is used for + suppressing Dialyzer warnings in generated code.

+

+ Own Id: OTP-12271

+ + +
+ +
+
Parsetools 2.0.12
Fixed Bugs and Malfunctions diff --git a/lib/parsetools/vsn.mk b/lib/parsetools/vsn.mk index dd9cc2991c..b99b3bb713 100644 --- a/lib/parsetools/vsn.mk +++ b/lib/parsetools/vsn.mk @@ -1 +1 @@ -PARSETOOLS_VSN = 2.0.12 +PARSETOOLS_VSN = 2.1 diff --git a/lib/percept/doc/src/notes.xml b/lib/percept/doc/src/notes.xml index b51c8fcb4d..19d6cd6d01 100644 --- a/lib/percept/doc/src/notes.xml +++ b/lib/percept/doc/src/notes.xml @@ -32,6 +32,21 @@

This document describes the changes made to the Percept application.

+
Percept 0.8.11 + +
Fixed Bugs and Malfunctions + + +

+ Fix http server configuration

+

+ Own Id: OTP-12662

+ + +
+ +
+
Percept 0.8.10
Fixed Bugs and Malfunctions diff --git a/lib/percept/vsn.mk b/lib/percept/vsn.mk index 4451354e21..833ab35aa5 100644 --- a/lib/percept/vsn.mk +++ b/lib/percept/vsn.mk @@ -1 +1 @@ -PERCEPT_VSN = 0.8.10 +PERCEPT_VSN = 0.8.11 diff --git a/lib/public_key/doc/src/notes.xml b/lib/public_key/doc/src/notes.xml index f241a91eb0..df65ad7004 100644 --- a/lib/public_key/doc/src/notes.xml +++ b/lib/public_key/doc/src/notes.xml @@ -34,6 +34,37 @@ notes.xml +
Public_Key 1.0 + +
Improvements and New Features + + +

+ public_key: Remove legacy switch compact_bit_string

+

+ E.i bitstrings will not be decode as {Unused, Binary}, + they are now Erlang bitstrings.

+

+ Also the compact_bit_string implies the + legacy_erlang_types switch So removing the switch will + also make OCTET STRING values be represented as binaries.

+

+ Undecoded open type will now be wrapped in a + asn1_OPENTYPE tuple.

+

+ This will change some values in records returned by the + public_key API making this change a potentiall + incompatibility.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-12110

+ + +
+ +
+
Public_Key 0.23
Improvements and New Features diff --git a/lib/sasl/doc/src/notes.xml b/lib/sasl/doc/src/notes.xml index 95d7c6fa50..c0ac0cf79c 100644 --- a/lib/sasl/doc/src/notes.xml +++ b/lib/sasl/doc/src/notes.xml @@ -30,6 +30,30 @@

This document describes the changes made to the SASL application.

+
SASL 2.4.2 + +
Fixed Bugs and Malfunctions + + +

+ The undocumented upgrade instruction + {remove_module,PrePurge,PostPurge,DepMods} is + removed. This instruction was added for symmetry reasons + in OTP R7B, but was never documented or tested.

+

+ The existing instruction {add_module,Mod,DepMods} + is now documented, and the complementing instruction + {delete_module,Mod,DepMods} is added.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-11540

+ + +
+ +
+
SASL 2.4.1
Fixed Bugs and Malfunctions diff --git a/lib/sasl/vsn.mk b/lib/sasl/vsn.mk index 4259a2d76c..8d1a043410 100644 --- a/lib/sasl/vsn.mk +++ b/lib/sasl/vsn.mk @@ -1 +1 @@ -SASL_VSN = 2.4.1 +SASL_VSN = 2.4.2 diff --git a/lib/ssh/doc/src/notes.xml b/lib/ssh/doc/src/notes.xml index 41885c684c..af5b78bff2 100644 --- a/lib/ssh/doc/src/notes.xml +++ b/lib/ssh/doc/src/notes.xml @@ -29,6 +29,72 @@ notes.xml +
Ssh 4.0 + +
Fixed Bugs and Malfunctions + + +

+ Included test of the 'e' and 'f' parameters in dh key + exchange as specified in rfc 4253 section 8.

+

+ Own Id: OTP-12649

+ + +

+ Fixes the bug that once the rekey_limit bytes (by + default, 1GB) had been transmitted the connection was + rekeyed every minute, not after the next 'rekey_limit'.

+

+ Thanks to Simon Cornish for the report and the fix!

+

+ Own Id: OTP-12692

+ + +

+ Fixes a bug that causes an SFTP connection to always fail + when {timeout, Timeout} option is used with + ssh_sftp:start_channel.

+

+ Thanks to Simon Cornish

+

+ Own Id: OTP-12708

+ + +
+ + +
Improvements and New Features + + +

+ The internal group to user_drv protocol has been changed + to be synchronous in order to guarantee that output sent + to a process implementing the user_drv protocol is + printed before replying. This protocol is used by the + standard_output device and the ssh application when + acting as a client.

+

+ This change changes the previous unlimited buffer when + printing to standard_io and other devices that end up in + user_drv to 1KB.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-12240

+ + +

+ If ssh_connection:subsystem/4 fails we do not want to + crash but rather terminate gracefully.

+

+ Own Id: OTP-12648 Aux Id: seq12834

+ + +
+ +
+
Ssh 3.2.2
Improvements and New Features diff --git a/lib/ssl/doc/src/notes.xml b/lib/ssl/doc/src/notes.xml index 352563700b..e0992d317c 100644 --- a/lib/ssl/doc/src/notes.xml +++ b/lib/ssl/doc/src/notes.xml @@ -25,7 +25,68 @@ notes.xml

This document describes the changes made to the SSL application.

-
SSL 6.0 +
SSL 7.0 + +
Fixed Bugs and Malfunctions + + +

+ Ignore signature_algorithm (TLS 1.2 extension) sent to + TLS 1.0 or TLS 1.1 server

+

+ Own Id: OTP-12670

+ + +
+ + +
Improvements and New Features + + +

+ Add new API functions to handle CRL-verification

+

+ Own Id: OTP-10362 Aux Id: kunagi-215 [126]

+ + +

+ Remove default support for SSL-3.0, due to Poodle + vunrability in protocol specification.

+

+ Add padding check for TLS-1.0 to remove Poodle + vunrability from TLS 1.0, also add the option + padding_check. This option only affects TLS-1.0 + connections and if set to false it disables the block + cipher padding check to be able to interoperate with + legacy software.

+

+ Remove default support for RC4 cipher suites, as they are + consider too weak.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-12390

+ + +

+ Add support for TLS ALPN (Application-Layer Protocol + Negotiation) extension.

+

+ Own Id: OTP-12580

+ + +

+ Add SNI (Server Name Indication) support for the server + side.

+

+ Own Id: OTP-12736

+ + +
+ +
+ +
SSL 6.0
Fixed Bugs and Malfunctions diff --git a/lib/stdlib/doc/src/notes.xml b/lib/stdlib/doc/src/notes.xml index 301a5ee2e8..3914a9bc0e 100644 --- a/lib/stdlib/doc/src/notes.xml +++ b/lib/stdlib/doc/src/notes.xml @@ -30,6 +30,224 @@

This document describes the changes made to the STDLIB application.

+
STDLIB 2.5 + +
Fixed Bugs and Malfunctions + + +

+ Fix handling of single dot in filename:join/2

+

+ The reference manual says that filename:join(A,B) is + equivalent to filename:join([A,B]). In some rare cases + this turns out not to be true. For example:

+

+ filename:join("/a/.","b") -> "/a/./b" vs + filename:join(["/a/.","b"]) -> "/a/b".

+

+ This has been corrected. A single dot is now only kept if + it occurs at the very beginning or the very end of the + resulting path.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-12158

+ + +

+ The undocumented option generic_debug for + gen_server has been removed.

+

+ Own Id: OTP-12183

+ + +

+ erl_lint:icrt_export/4 has been rewritten to make the + code really follow the scoping rules of Erlang, and not + just in most situations by accident.

+

+ Own Id: OTP-12186

+ + +

+ Add 'trim_all' option to binary:split/3

+

+ This option can be set to remove _ALL_ empty parts of the + result of a call to binary:split/3.

+

+ Own Id: OTP-12301

+ + +

Correct orddict(3) regarding evaluation order of + fold() and map().

+

+ Own Id: OTP-12651 Aux Id: seq12832

+ + +

+ Correct maps module error exceptions

+

+ Bad input to maps module function will now yield the + following exceptions: {badmap,NotMap} + or, badarg

+

+ Own Id: OTP-12657

+ + +

+ It is now possible to paste text in JCL mode (using + Ctrl-Y) that has been copied in the previous shell + session. Also a bug that caused the JCL mode to crash + when pasting text has been fixed.

+

+ Own Id: OTP-12673

+ + +
+ + +
Improvements and New Features + + +

+ Allow maps for supervisor flags and child specs

+

+ Earlier, supervisor flags and child specs were given as + tuples. While this is kept for backwards compatibility, + it is now also allowed to give these parameters as maps, + see sup_flags + and child_spec.

+

+ Own Id: OTP-11043

+ + +

+ A new system message, terminate, is added. This + can be sent with sys:terminate/2,3. If the + receiving process handles system messages properly it + will terminate shortly after receiving this message.

+

+ The new function proc_lib:stop/1,3 utilizes this + new system message and monitors the receiving process in + order to facilitate a synchronous stop mechanism for + 'special processes'.

+

+ proc_lib:stop/1,3 is used by the following + functions:

+

+ gen_server:stop/1,3 (new) + gen_fsm:stop/1,3 (new) + gen_event:stop/1,3 (modified to be + synchronous) wx_object:stop/1,3 + (new)

+

+ Own Id: OTP-11173 Aux Id: seq12353

+ + +

+ Remove the pg module, which has been deprecated + through OTP-17, is now removed from the STDLIB + application. This module has been marked experimental for + more than 15 years, and has largely been superseded by + the pg2 module from the Kernel application.

+

+ Own Id: OTP-11907

+ + +

+ New BIF: erlang:get_keys/0, lists all keys + associated with the process dictionary. Note: + erlang:get_keys/0 is auto-imported.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-12151 Aux Id: seq12521

+ + +

Add three new functions to io_lib-- + scan_format/2, unscan_format/1, and + build_text/1-- which expose the parsed form of the + format control sequences to make it possible to easily + modify or filter the input to io_lib:format/2. + This can e.g. be used in order to replace unbounded-size + control sequences like ~w or ~p with + corresponding depth-limited ~W and ~P + before doing the actual formatting.

+

+ Own Id: OTP-12167

+ + +

Introduce the erl_anno module, an abstraction + of the second element of tokens and tuples in the + abstract format.

+

+ Own Id: OTP-12195

+ + +

+ Support variables as Map keys in expressions and patterns

+

Erlang will accept any expression as keys in Map + expressions and it will accept literals or bound + variables as keys in Map patterns.

+

+ Own Id: OTP-12218

+ + +

The last traces of Mnemosyne Rules have been removed. +

+

+ Own Id: OTP-12257

+ + +

+ Properly support maps in match_specs

+

+ Own Id: OTP-12270

+ + +

+ New function ets:take/2. Works the same as + ets:delete/2 but also returns the deleted + object(s).

+

+ Own Id: OTP-12309

+ + +

string:tokens/2 is somewhat faster, especially + if the list of separators only contains one separator + character.

+

+ Own Id: OTP-12422 Aux Id: seq12774

+ + +

+ Prevent zip:zip_open/[12] from leaking file descriptors + if parent process dies.

+

+ Own Id: OTP-12566

+ + +

+ Add a new random number generator, see rand + module. It have better characteristics and an improved + interface.

+

+ Own Id: OTP-12586 Aux Id: OTP-12501, OTP-12502

+ + +

filename:split/1 when given an empty binary + will now return an empty list, to make it consistent with + return value when given an empty list.

+

+ Own Id: OTP-12716

+ + +
+ +
+
STDLIB 2.4
Fixed Bugs and Malfunctions diff --git a/lib/stdlib/vsn.mk b/lib/stdlib/vsn.mk index f57f31c8de..a1f2a946b1 100644 --- a/lib/stdlib/vsn.mk +++ b/lib/stdlib/vsn.mk @@ -1 +1 @@ -STDLIB_VSN = 2.4 +STDLIB_VSN = 2.5 diff --git a/lib/syntax_tools/doc/src/notes.xml b/lib/syntax_tools/doc/src/notes.xml index 408f6d5bac..8f245083c4 100644 --- a/lib/syntax_tools/doc/src/notes.xml +++ b/lib/syntax_tools/doc/src/notes.xml @@ -31,6 +31,20 @@

This document describes the changes made to the Syntax_Tools application.

+
Syntax_Tools 1.7 + +
Improvements and New Features + + +

Use the new erl_anno module.

+

+ Own Id: OTP-12732

+ + +
+ +
+
Syntax_Tools 1.6.18
Fixed Bugs and Malfunctions diff --git a/lib/syntax_tools/vsn.mk b/lib/syntax_tools/vsn.mk index 1c42ef0ddb..403e90196e 100644 --- a/lib/syntax_tools/vsn.mk +++ b/lib/syntax_tools/vsn.mk @@ -1 +1 @@ -SYNTAX_TOOLS_VSN = 1.6.18 +SYNTAX_TOOLS_VSN = 1.7 diff --git a/lib/test_server/doc/src/notes.xml b/lib/test_server/doc/src/notes.xml index e996d2b4a3..6cf7a2b52d 100644 --- a/lib/test_server/doc/src/notes.xml +++ b/lib/test_server/doc/src/notes.xml @@ -32,6 +32,55 @@ notes.xml +
Test_Server 3.9 + +
Fixed Bugs and Malfunctions + + +

+ The status of an aborted test due to test suite + compilation error has changed from 'auto_skipped' to + 'failed'. This affects both the textual log file, event + handling and CT hook callbacks. The logging of + compilation failures has also been improved, especially + in the case of multiple test suites failing compilation.

+

+ Own Id: OTP-10816

+ + +
+ + +
Improvements and New Features + + +

+ The Test Server application has been marked as obsolete + and will be removed from OTP in the next major release + (OTP 19.0).

+

+ Own Id: OTP-10923 Aux Id: OTP-12705

+ + +

+ When running OTP tests using the ts interface, it is now + possible to specify so called test categories per OTP + application. A test category is represented by a CT test + specification and defines an arbitrary subset of existing + test suites, groups and cases. Examples of test + categories are 'smoke' (smoke tests) and 'bench' + (benchmarks). (Call ts:help() for more info). Also, + functions for reading terms from the current test + specification during test, ct:get_testspec_terms/0 and + ct:get_testspec_terms/1, have been implemented.

+

+ Own Id: OTP-11962

+ + +
+ +
+
Test_Server 3.8.1
Fixed Bugs and Malfunctions diff --git a/lib/tools/doc/src/notes.xml b/lib/tools/doc/src/notes.xml index 38b57b73a9..85610d623a 100644 --- a/lib/tools/doc/src/notes.xml +++ b/lib/tools/doc/src/notes.xml @@ -30,6 +30,65 @@

This document describes the changes made to the Tools application.

+
Tools 2.8 + +
Fixed Bugs and Malfunctions + + +

+ In order to improve performance of the cover tool, new + functions are added for cover compilation and analysis on + multiple files. This allows for more parallelisation.

+

+ Some improvements of the data base access is also done in + order to improve the performance when analysing and + resetting cover data.

+

+ Minor incompatibility: An error reason from + analyse_to_file is changed from no_source_code_found to + {no_source_code_found,Module}.

+

+ *** POTENTIAL INCOMPATIBILITY ***

+

+ Own Id: OTP-12330 Aux Id: seq12757

+ + +
+ + +
Improvements and New Features + + +

+ Allow maps for supervisor flags and child specs

+

+ Earlier, supervisor flags and child specs were given as + tuples. While this is kept for backwards compatibility, + it is now also allowed to give these parameters as maps, + see sup_flags + and child_spec.

+

+ Own Id: OTP-11043

+ + +

+ Remove Mnemosyne rules support.

+

+ Own Id: OTP-12511

+ + +

+ Add printout of total number of calls and time in eprof

+

+ Own Id: OTP-12681

+ + +
+ +
+
Tools 2.7.2
Fixed Bugs and Malfunctions diff --git a/lib/tools/vsn.mk b/lib/tools/vsn.mk index 3b3202d38b..68c3f6e29c 100644 --- a/lib/tools/vsn.mk +++ b/lib/tools/vsn.mk @@ -1 +1 @@ -TOOLS_VSN = 2.7.2 +TOOLS_VSN = 2.8 diff --git a/lib/typer/doc/src/notes.xml b/lib/typer/doc/src/notes.xml index 23e22759d6..045b55ffe4 100644 --- a/lib/typer/doc/src/notes.xml +++ b/lib/typer/doc/src/notes.xml @@ -30,6 +30,20 @@

This document describes the changes made to TypEr.

+
TypEr 0.9.9 + +
Fixed Bugs and Malfunctions + + +

Properly extract annotations from core code.

+

+ Own Id: OTP-12727

+ + +
+ +
+
TypEr 0.9.8
Fixed Bugs and Malfunctions diff --git a/lib/typer/vsn.mk b/lib/typer/vsn.mk index ce658e257b..74c0ccfc59 100644 --- a/lib/typer/vsn.mk +++ b/lib/typer/vsn.mk @@ -1 +1 @@ -TYPER_VSN = 0.9.8 +TYPER_VSN = 0.9.9 diff --git a/lib/webtool/doc/src/notes.xml b/lib/webtool/doc/src/notes.xml index e571668c91..4800dd6df4 100644 --- a/lib/webtool/doc/src/notes.xml +++ b/lib/webtool/doc/src/notes.xml @@ -31,6 +31,23 @@

This document describes the changes made to the Webtool application.

+
WebTool 0.9 + +
Improvements and New Features + + +

+ The Webtool application has been marked as obsolete and + will be removed from OTP in the next major release (OTP + 19.0).

+

+ Own Id: OTP-10922 Aux Id: OTP-12705

+ + +
+ +
+
WebTool 0.8.10
Fixed Bugs and Malfunctions diff --git a/lib/wx/doc/src/notes.xml b/lib/wx/doc/src/notes.xml index 682ab48ca0..d31e927458 100644 --- a/lib/wx/doc/src/notes.xml +++ b/lib/wx/doc/src/notes.xml @@ -31,6 +31,55 @@

This document describes the changes made to the wxErlang application.

+
Wx 1.4 + +
Fixed Bugs and Malfunctions + + +

+ The undocumented option generic_debug for + gen_server has been removed.

+

+ Own Id: OTP-12183

+ + +
+ + +
Improvements and New Features + + +

+ Use wxWidgets-3.0, if found, as default backend on + windows.

+

+ Own Id: OTP-12632

+ + +

+ Add missing fields in some events records. May require a + recompilation of user applications.

+

+ Own Id: OTP-12660

+ + +
+ + +
Known Bugs and Problems + + +

+ Remove raise condition where wx could crash during + emulator stoppage.

+

+ Own Id: OTP-12734

+ + +
+ +
+
Wx 1.3.3
Fixed Bugs and Malfunctions diff --git a/lib/wx/vsn.mk b/lib/wx/vsn.mk index 942d4c0d6f..09fb9f384c 100644 --- a/lib/wx/vsn.mk +++ b/lib/wx/vsn.mk @@ -1 +1 @@ -WX_VSN = 1.3.3 +WX_VSN = 1.4 diff --git a/lib/xmerl/doc/src/notes.xml b/lib/xmerl/doc/src/notes.xml index 3fa1f01a79..b9cc2bd329 100644 --- a/lib/xmerl/doc/src/notes.xml +++ b/lib/xmerl/doc/src/notes.xml @@ -31,6 +31,20 @@

This document describes the changes made to the Xmerl application.

+
Xmerl 1.3.8 + +
Fixed Bugs and Malfunctions + + +

Remove compiler warnings in xmerl.

+

+ Own Id: OTP-12689

+ + +
+ +
+
Xmerl 1.3.7
Fixed Bugs and Malfunctions -- cgit v1.2.3 From 9a81b28598fadc44bf506354c9227e41aac786f6 Mon Sep 17 00:00:00 2001 From: Henrik Nord Date: Wed, 13 May 2015 09:40:16 +0200 Subject: Revert "Prepare release" This reverts commit e09dd66dc4d89c62ddfd8c19791f9678d5d787c6. --- lib/asn1/doc/src/notes.xml | 17 --- lib/asn1/vsn.mk | 2 +- lib/common_test/doc/src/notes.xml | 73 ------------ lib/compiler/doc/src/notes.xml | 88 -------------- lib/compiler/vsn.mk | 2 +- lib/cosEvent/doc/src/notes.xml | 18 +-- lib/cosEventDomain/doc/src/notes.xml | 18 +-- lib/cosFileTransfer/doc/src/notes.xml | 18 +-- lib/cosNotification/doc/src/notes.xml | 18 +-- lib/cosProperty/doc/src/notes.xml | 18 +-- lib/cosTime/doc/src/notes.xml | 18 +-- lib/cosTransactions/doc/src/notes.xml | 18 +-- lib/crypto/doc/src/notes.xml | 43 ------- lib/crypto/vsn.mk | 2 +- lib/debugger/doc/src/notes.xml | 18 --- lib/debugger/vsn.mk | 2 +- lib/dialyzer/doc/src/notes.xml | 86 -------------- lib/dialyzer/vsn.mk | 2 +- lib/edoc/doc/src/notes.xml | 15 --- lib/edoc/vsn.mk | 2 +- lib/eldap/doc/src/notes.xml | 16 --- lib/eunit/doc/src/notes.xml | 14 --- lib/eunit/vsn.mk | 2 +- lib/hipe/doc/src/notes.xml | 36 ------ lib/hipe/vsn.mk | 2 +- lib/inets/doc/src/notes.xml | 21 +--- lib/inets/vsn.mk | 2 +- lib/jinterface/doc/src/notes.xml | 53 --------- lib/jinterface/vsn.mk | 2 +- lib/kernel/doc/src/notes.xml | 73 ------------ lib/kernel/vsn.mk | 2 +- lib/mnesia/doc/src/notes.xml | 32 +---- lib/mnesia/vsn.mk | 2 +- lib/observer/doc/src/notes.xml | 22 ---- lib/observer/vsn.mk | 2 +- lib/orber/doc/src/notes.xml | 18 +-- lib/os_mon/doc/src/notes.xml | 19 --- lib/os_mon/vsn.mk | 2 +- lib/parsetools/doc/src/notes.xml | 15 --- lib/parsetools/vsn.mk | 2 +- lib/percept/doc/src/notes.xml | 15 --- lib/percept/vsn.mk | 2 +- lib/public_key/doc/src/notes.xml | 31 ----- lib/sasl/doc/src/notes.xml | 24 ---- lib/sasl/vsn.mk | 2 +- lib/ssh/doc/src/notes.xml | 66 ---------- lib/ssl/doc/src/notes.xml | 63 +--------- lib/stdlib/doc/src/notes.xml | 218 ---------------------------------- lib/stdlib/vsn.mk | 2 +- lib/syntax_tools/doc/src/notes.xml | 14 --- lib/syntax_tools/vsn.mk | 2 +- lib/test_server/doc/src/notes.xml | 49 -------- lib/tools/doc/src/notes.xml | 59 --------- lib/tools/vsn.mk | 2 +- lib/typer/doc/src/notes.xml | 14 --- lib/typer/vsn.mk | 2 +- lib/webtool/doc/src/notes.xml | 17 --- lib/wx/doc/src/notes.xml | 49 -------- lib/wx/vsn.mk | 2 +- lib/xmerl/doc/src/notes.xml | 14 --- 60 files changed, 33 insertions(+), 1429 deletions(-) (limited to 'lib') diff --git a/lib/asn1/doc/src/notes.xml b/lib/asn1/doc/src/notes.xml index f73d21b9e3..9feb673c04 100644 --- a/lib/asn1/doc/src/notes.xml +++ b/lib/asn1/doc/src/notes.xml @@ -31,23 +31,6 @@

This document describes the changes made to the asn1 application.

-
Asn1 4.0 - -
Fixed Bugs and Malfunctions - - -

- Many bugs have been eliminated in the the ASN.1 compiler - so that it can now successfully compile many more ASN.1 - specifications. Error messages have also been improved.

-

- Own Id: OTP-12395

- - -
- -
-
Asn1 3.0.4
Fixed Bugs and Malfunctions diff --git a/lib/asn1/vsn.mk b/lib/asn1/vsn.mk index d4c46863a3..c909c908d6 100644 --- a/lib/asn1/vsn.mk +++ b/lib/asn1/vsn.mk @@ -1 +1 @@ -ASN1_VSN = 4.0 +ASN1_VSN = 3.0.4 diff --git a/lib/common_test/doc/src/notes.xml b/lib/common_test/doc/src/notes.xml index 218f76d403..472e3b7833 100644 --- a/lib/common_test/doc/src/notes.xml +++ b/lib/common_test/doc/src/notes.xml @@ -32,79 +32,6 @@ notes.xml -
Common_Test 1.11 - -
Fixed Bugs and Malfunctions - - -

- The status of an aborted test due to test suite - compilation error has changed from 'auto_skipped' to - 'failed'. This affects both the textual log file, event - handling and CT hook callbacks. The logging of - compilation failures has also been improved, especially - in the case of multiple test suites failing compilation.

-

- Own Id: OTP-10816

- - -
- - -
Improvements and New Features - - -

- Earlier there was no way to add optional parameters like - default-operation to an edit-config request sent with - ct_netconfc:edit_config/3,4, you had to use - ct_netconfc:send_rpc/2,3. For simplicity and completion, - a new optional argument, OptParams, is now added to the - edit_config function.

-

- Own Id: OTP-10446 Aux Id: kunagi-266 [177]

- - -

- When running OTP tests using the ts interface, it is now - possible to specify so called test categories per OTP - application. A test category is represented by a CT test - specification and defines an arbitrary subset of existing - test suites, groups and cases. Examples of test - categories are 'smoke' (smoke tests) and 'bench' - (benchmarks). (Call ts:help() for more info). Also, - functions for reading terms from the current test - specification during test, ct:get_testspec_terms/0 and - ct:get_testspec_terms/1, have been implemented.

-

- Own Id: OTP-11962

- - -

- Obsolete scripts and make file operations have been - removed and the installation chapter in the Common Test - User's Guide has been updated.

-

- Own Id: OTP-12421

- - -

- The 'keep_alive' interval has been reduced to 8 seconds, - which is two seconds shorter than the default - 'idle_timeout' value for ct_telnet:expect/3. This way, - the telnet server receives a NOP message (which might - trigger an action) before the operation times out. Also - the TCP option 'nodelay' has been enabled per default for - all telnet connections, in order to reduce the risk for - communication timeouts.

-

- Own Id: OTP-12678 Aux Id: seq12818

- - -
- -
-
Common_Test 1.10.1
Fixed Bugs and Malfunctions diff --git a/lib/compiler/doc/src/notes.xml b/lib/compiler/doc/src/notes.xml index 0654738247..9b5b44f3e1 100644 --- a/lib/compiler/doc/src/notes.xml +++ b/lib/compiler/doc/src/notes.xml @@ -31,94 +31,6 @@

This document describes the changes made to the Compiler application.

-
Compiler 6.0 - -
Fixed Bugs and Malfunctions - - -

- The compiler optimizes away building of terms that are - never actually used. As a result, the compiler in OTP 18 - may produce more warnings for terms that are built but - not used than the compiler in OTP 17.

-

- Own Id: OTP-12453

- - -

- Using a map could incorrectly suppress warnings for - unused variables.

-

- Own Id: OTP-12515

- - -

- The compiler now properly reports unknown parse - transforms. That is, undef exceptions coming from - the parse transform itself is reported differently from - the absence of the parse transform.

-

- Own Id: OTP-12723

- - -
- - -
Improvements and New Features - - -

- The cerl and cerl_trees modules in the - compiler application are now documented.

-

- Own Id: OTP-11978

- - -

- The deprecated 'asm' option has been removed.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-12100

- - -

- Support variables as Map keys in expressions and patterns

-

Erlang will accept any expression as keys in Map - expressions and it will accept literals or bound - variables as keys in Map patterns.

-

- Own Id: OTP-12218

- - -

- Infer Map type information in beam_type compiler - optimization pass.

-

- Own Id: OTP-12253

- - -

- Compiler optimizations have been improved.

-

- Own Id: OTP-12393

- - -

- Five undocumented functions in the module core_lib - have been deprecated and will be removed in the next - major release. The functions are: get_anno/{1,2}, - is_literal/1, is_literal_list/1, and - literal_value. Use the appropriate functions in - the cerl module instead.

-

- Own Id: OTP-12497

- - -
- -
-
Compiler 5.0.4
Fixed Bugs and Malfunctions diff --git a/lib/compiler/vsn.mk b/lib/compiler/vsn.mk index 69f71ba5dd..05e682c893 100644 --- a/lib/compiler/vsn.mk +++ b/lib/compiler/vsn.mk @@ -1 +1 @@ -COMPILER_VSN = 6.0 +COMPILER_VSN = 5.0.4 diff --git a/lib/cosEvent/doc/src/notes.xml b/lib/cosEvent/doc/src/notes.xml index 229e0c9945..8f519447fc 100644 --- a/lib/cosEvent/doc/src/notes.xml +++ b/lib/cosEvent/doc/src/notes.xml @@ -32,23 +32,7 @@ notes.xml -
cosEvent 2.2 - -
Improvements and New Features - - -

Remove the usage of erlang:now() from all Corba - applications and use the new rand module instead of - random.

-

- Own Id: OTP-12687

- - -
- -
- -
cosEvent 2.1.15 +
cosEvent 2.1.15
Improvements and New Features diff --git a/lib/cosEventDomain/doc/src/notes.xml b/lib/cosEventDomain/doc/src/notes.xml index 72408b52f4..2c3bf16411 100644 --- a/lib/cosEventDomain/doc/src/notes.xml +++ b/lib/cosEventDomain/doc/src/notes.xml @@ -31,23 +31,7 @@ notes.xml -
cosEventDomain 1.2 - -
Improvements and New Features - - -

Remove the usage of erlang:now() from all Corba - applications and use the new rand module instead of - random.

-

- Own Id: OTP-12687

- - -
- -
- -
cosEventDomain 1.1.14 +
cosEventDomain 1.1.14
Improvements and New Features diff --git a/lib/cosFileTransfer/doc/src/notes.xml b/lib/cosFileTransfer/doc/src/notes.xml index a3cce2a7d8..1d0c826d40 100644 --- a/lib/cosFileTransfer/doc/src/notes.xml +++ b/lib/cosFileTransfer/doc/src/notes.xml @@ -30,23 +30,7 @@ notes.xml -
cosFileTransfer 1.2 - -
Improvements and New Features - - -

Remove the usage of erlang:now() from all Corba - applications and use the new rand module instead of - random.

-

- Own Id: OTP-12687

- - -
- -
- -
cosFileTransfer 1.1.16 +
cosFileTransfer 1.1.16
Improvements and New Features diff --git a/lib/cosNotification/doc/src/notes.xml b/lib/cosNotification/doc/src/notes.xml index b16571a1cf..2e4f922142 100644 --- a/lib/cosNotification/doc/src/notes.xml +++ b/lib/cosNotification/doc/src/notes.xml @@ -31,23 +31,7 @@ notes.xml -
cosNotification 1.2 - -
Improvements and New Features - - -

Remove the usage of erlang:now() from all Corba - applications and use the new rand module instead of - random.

-

- Own Id: OTP-12687

- - -
- -
- -
cosNotification 1.1.21 +
cosNotification 1.1.21
Improvements and New Features diff --git a/lib/cosProperty/doc/src/notes.xml b/lib/cosProperty/doc/src/notes.xml index 1885a8fd6b..739f41617f 100644 --- a/lib/cosProperty/doc/src/notes.xml +++ b/lib/cosProperty/doc/src/notes.xml @@ -31,23 +31,7 @@ notes.xml -
cosProperty 1.2 - -
Improvements and New Features - - -

Remove the usage of erlang:now() from all Corba - applications and use the new rand module instead of - random.

-

- Own Id: OTP-12687

- - -
- -
- -
cosProperty 1.1.17 +
cosProperty 1.1.17
Improvements and New Features diff --git a/lib/cosTime/doc/src/notes.xml b/lib/cosTime/doc/src/notes.xml index 6c948c8c2b..f218f19a6b 100644 --- a/lib/cosTime/doc/src/notes.xml +++ b/lib/cosTime/doc/src/notes.xml @@ -32,23 +32,7 @@ notes.xml -
cosTime 1.2 - -
Improvements and New Features - - -

Remove the usage of erlang:now() from all Corba - applications and use the new rand module instead of - random.

-

- Own Id: OTP-12687

- - -
- -
- -
cosTime 1.1.14 +
cosTime 1.1.14
Improvements and New Features diff --git a/lib/cosTransactions/doc/src/notes.xml b/lib/cosTransactions/doc/src/notes.xml index ae3b9eb6f2..4b20f23efb 100644 --- a/lib/cosTransactions/doc/src/notes.xml +++ b/lib/cosTransactions/doc/src/notes.xml @@ -32,23 +32,7 @@ notes.xml -
cosTransactions 1.3 - -
Improvements and New Features - - -

Remove the usage of erlang:now() from all Corba - applications and use the new rand module instead of - random.

-

- Own Id: OTP-12687

- - -
- -
- -
cosTransactions 1.2.14 +
cosTransactions 1.2.14
Improvements and New Features diff --git a/lib/crypto/doc/src/notes.xml b/lib/crypto/doc/src/notes.xml index 6ab109e349..a0ebc4b3dd 100644 --- a/lib/crypto/doc/src/notes.xml +++ b/lib/crypto/doc/src/notes.xml @@ -30,49 +30,6 @@

This document describes the changes made to the Crypto application.

-
Crypto 3.6 - -
Fixed Bugs and Malfunctions - - -

- Enhance crypto:generate_key to calculate ECC public keys - from private key.

-

- Own Id: OTP-12394

- - -

- Fix bug in crypto:generate_key for ecdh - that could cause VM crash for faulty input.

-

- Own Id: OTP-12733

- - -
- - -
Improvements and New Features - - -

- Use the EVP API for AES-CBC crypto to enables the use of - hardware acceleration for AES-CBC crypto on newer Intel - CPUs (AES-NI), among other platforms.

-

- Own Id: OTP-12380

- - -

- Add AES ECB block encryption.

-

- Own Id: OTP-12403

- - -
- -
-
Crypto 3.5
Improvements and New Features diff --git a/lib/crypto/vsn.mk b/lib/crypto/vsn.mk index 55b1b3e8c4..8489b59562 100644 --- a/lib/crypto/vsn.mk +++ b/lib/crypto/vsn.mk @@ -1 +1 @@ -CRYPTO_VSN = 3.6 +CRYPTO_VSN = 3.5 diff --git a/lib/debugger/doc/src/notes.xml b/lib/debugger/doc/src/notes.xml index 2bf80597b5..7384189a6f 100644 --- a/lib/debugger/doc/src/notes.xml +++ b/lib/debugger/doc/src/notes.xml @@ -32,24 +32,6 @@

This document describes the changes made to the Debugger application.

-
Debugger 4.1 - -
Improvements and New Features - - -

- Support variables as Map keys in expressions and patterns

-

Erlang will accept any expression as keys in Map - expressions and it will accept literals or bound - variables as keys in Map patterns.

-

- Own Id: OTP-12218

- - -
- -
-
Debugger 4.0.3
Fixed Bugs and Malfunctions diff --git a/lib/debugger/vsn.mk b/lib/debugger/vsn.mk index b6fd4e8e44..b82f0f4e37 100644 --- a/lib/debugger/vsn.mk +++ b/lib/debugger/vsn.mk @@ -1 +1 @@ -DEBUGGER_VSN = 4.1 +DEBUGGER_VSN = 4.0.3 diff --git a/lib/dialyzer/doc/src/notes.xml b/lib/dialyzer/doc/src/notes.xml index d30882b5b9..8976679c1d 100644 --- a/lib/dialyzer/doc/src/notes.xml +++ b/lib/dialyzer/doc/src/notes.xml @@ -31,92 +31,6 @@

This document describes the changes made to the Dialyzer application.

-
Dialyzer 2.8 - -
Fixed Bugs and Malfunctions - - -

The translation of Erlang forms to the type - representation used by Dialyzer has been improved in - several ways. The most important change is that deeply - nested records can be handled.

-

- Own Id: OTP-12350

- - -

Update the PLT properly when a module is changed. - (Thanks to James Fish for the bug report, and to Stavros - Aronis for fixing the bug.)

-

- Own Id: OTP-12637

- - -

- An argument of '*'/2 is not constraind if the other - operand can be zero.

-

- Own Id: OTP-12725

- - -
- - -
Improvements and New Features - - -

The -dialyzer() attribute can be used for - suppressing warnings in a module by specifying functions - or warning options. It can also be used for requesting - warnings in a module.

-

- Own Id: OTP-10280

- - -

The pre-defined types array(), dict(), - digraph(), gb_set(), gb_tree(), - queue(), set(), and tid() have been - removed.

-

- Own Id: OTP-11445 Aux Id: OTP-10342, OTP-9352

- - -

A few type names that have been used for representing - certain predefined types can now be used for user-defined - types. This affects the types product/_, - union/_, and range/2 as well as - tuple/N (N > 0), map/N (N > 0), - atom/1, integer/1, binary/2, - record/_, and 'fun'/_. A consequence is - that, for example, it is no longer possible to refer to a - record type with record(r); instead the usual - record notation, #r{}, is to be used.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-11851

- - -

When implementing user-defined behaviours it is now - possible to specify optional callback functions. See OTP - Design Principles User's Guide, Sys and Proc_Lib, - User-Defined Behaviours, for details.

-

- Own Id: OTP-11861

- - -

Add two options to the Dialyzer: - no_missing_calls suppresses warnings about calls - to missing or unexported functions; unknown lets - warnings about unknown functions or types affect the exit - status. See also dialyzer(3).

-

- Own Id: OTP-12682

- - -
- -
-
Dialyzer 2.7.4
Fixed Bugs and Malfunctions diff --git a/lib/dialyzer/vsn.mk b/lib/dialyzer/vsn.mk index 48e0830109..527afaf4ef 100644 --- a/lib/dialyzer/vsn.mk +++ b/lib/dialyzer/vsn.mk @@ -1 +1 @@ -DIALYZER_VSN = 2.8 +DIALYZER_VSN = 2.7.4 diff --git a/lib/edoc/doc/src/notes.xml b/lib/edoc/doc/src/notes.xml index 48bb415ab3..e350adb540 100644 --- a/lib/edoc/doc/src/notes.xml +++ b/lib/edoc/doc/src/notes.xml @@ -31,21 +31,6 @@

This document describes the changes made to the EDoc application.

-
Edoc 0.7.17 - -
Improvements and New Features - - -

- Remove functionality related to packages

-

- Own Id: OTP-12431

- - -
- -
-
Edoc 0.7.16
Fixed Bugs and Malfunctions diff --git a/lib/edoc/vsn.mk b/lib/edoc/vsn.mk index 49a73331c6..24cfbf16d5 100644 --- a/lib/edoc/vsn.mk +++ b/lib/edoc/vsn.mk @@ -1 +1 @@ -EDOC_VSN = 0.7.17 +EDOC_VSN = 0.7.16 diff --git a/lib/eldap/doc/src/notes.xml b/lib/eldap/doc/src/notes.xml index a7aefefb4a..e76101c30e 100644 --- a/lib/eldap/doc/src/notes.xml +++ b/lib/eldap/doc/src/notes.xml @@ -30,22 +30,6 @@

This document describes the changes made to the Eldap application.

-
Eldap 1.2 - -
Improvements and New Features - - -

- Support added for LDAP Password Modify Extended Operation - (RFC 3062). Thanks to danielwhite.

-

- Own Id: OTP-12282

- - -
- -
-
Eldap 1.1.1
Fixed Bugs and Malfunctions diff --git a/lib/eunit/doc/src/notes.xml b/lib/eunit/doc/src/notes.xml index 3c6daf142e..6b76e097b6 100644 --- a/lib/eunit/doc/src/notes.xml +++ b/lib/eunit/doc/src/notes.xml @@ -32,20 +32,6 @@

This document describes the changes made to the EUnit application.

-
Eunit 2.2.10 - -
Fixed Bugs and Malfunctions - - -

The eunit application is now unicode safe.

-

- Own Id: OTP-11660

- - -
- -
-
Eunit 2.2.9
Fixed Bugs and Malfunctions diff --git a/lib/eunit/vsn.mk b/lib/eunit/vsn.mk index 8b489bdc04..dca8b3ece0 100644 --- a/lib/eunit/vsn.mk +++ b/lib/eunit/vsn.mk @@ -1 +1 @@ -EUNIT_VSN = 2.2.10 +EUNIT_VSN = 2.2.9 diff --git a/lib/hipe/doc/src/notes.xml b/lib/hipe/doc/src/notes.xml index 1cc8558fe8..8d3358533b 100644 --- a/lib/hipe/doc/src/notes.xml +++ b/lib/hipe/doc/src/notes.xml @@ -30,42 +30,6 @@

This document describes the changes made to HiPE.

-
Hipe 3.12 - -
Fixed Bugs and Malfunctions - - -

Fix a minor bug in the handling of opaque types.

-

- Own Id: OTP-12666

- - -

- Fix hipe bug when matching a "writable" binary. The bug - has been seen to sometimes cause a failed binary matching - of a correct utf8 character, but other symptoms are also - possible.

-

- Own Id: OTP-12667

- - -
- - -
Improvements and New Features - - -

- Improved error handling when memory allocation for HiPE - code fails.

-

- Own Id: OTP-12448

- - -
- -
-
Hipe 3.11.3
Fixed Bugs and Malfunctions diff --git a/lib/hipe/vsn.mk b/lib/hipe/vsn.mk index e507ae933f..60b4e0559b 100644 --- a/lib/hipe/vsn.mk +++ b/lib/hipe/vsn.mk @@ -1 +1 @@ -HIPE_VSN = 3.12 +HIPE_VSN = 3.11.3 diff --git a/lib/inets/doc/src/notes.xml b/lib/inets/doc/src/notes.xml index 7939787601..12bbc2b736 100644 --- a/lib/inets/doc/src/notes.xml +++ b/lib/inets/doc/src/notes.xml @@ -32,26 +32,7 @@ notes.xml -
Inets 6.0 - -
Improvements and New Features - - -

- Remove Server Side Include support from inets, as this is - an old technic that has security issues and was not well - tested.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-12156

- - -
- -
- -
Inets 5.10.7 +
Inets 5.10.7
Improvements and New Features diff --git a/lib/inets/vsn.mk b/lib/inets/vsn.mk index d5cb460404..e9ecb2632a 100644 --- a/lib/inets/vsn.mk +++ b/lib/inets/vsn.mk @@ -18,6 +18,6 @@ # %CopyrightEnd% APPLICATION = inets -INETS_VSN = 6.0 +INETS_VSN = 5.10.7 PRE_VSN = APP_VSN = "$(APPLICATION)-$(INETS_VSN)$(PRE_VSN)" diff --git a/lib/jinterface/doc/src/notes.xml b/lib/jinterface/doc/src/notes.xml index f854fa1f3a..fc5f8be53e 100644 --- a/lib/jinterface/doc/src/notes.xml +++ b/lib/jinterface/doc/src/notes.xml @@ -30,59 +30,6 @@

This document describes the changes made to the Jinterface application.

-
Jinterface 1.6 - -
Fixed Bugs and Malfunctions - - -

- Reformat the sources for JInterface uniformly and - according to the standard Java style guidelines. Provide - description of the rules applied in Eclipse format (for - other editors one can check the settings against these).

-

- In short, the formatting style is: * indentation uses - only spaces; each level is 4 positions * no trailing - whitespace * mostly default Java style formatting (any - difference is minor) * always use {} blocks * use 'final' - as much as possible

-

- Own Id: OTP-12333

- - -
- - -
Improvements and New Features - - -

- Add basic transport factory implementation. This makes - possible creating connections between nodes using ssh - channels for example.

-

- Own Id: OTP-12686

- - -

- Add Jinterface generic match and bind methods to provide - low level interface base methods sufficient for variety - of higher level pattern matching/variable binding - implementations.

-

- Own Id: OTP-12691

- - -

- Minimal Java version is now 1.6

-

- Own Id: OTP-12718

- - -
- -
-
Jinterface 1.5.12
Fixed Bugs and Malfunctions diff --git a/lib/jinterface/vsn.mk b/lib/jinterface/vsn.mk index 4df01d1151..72ad316333 100644 --- a/lib/jinterface/vsn.mk +++ b/lib/jinterface/vsn.mk @@ -1 +1 @@ -JINTERFACE_VSN = 1.6 +JINTERFACE_VSN = 1.5.12 diff --git a/lib/kernel/doc/src/notes.xml b/lib/kernel/doc/src/notes.xml index 0bd9a067ca..6f7f18a8e7 100644 --- a/lib/kernel/doc/src/notes.xml +++ b/lib/kernel/doc/src/notes.xml @@ -30,79 +30,6 @@

This document describes the changes made to the Kernel application.

-
Kernel 4.0 - -
Fixed Bugs and Malfunctions - - -

- Fix error handling in file:read_line/1 for Unicode - contents.

-

- Own Id: OTP-12144

- - -

- Introduce os:getenv/2 which is similar to - os:getenv/1 but returns the passed default value - if the required environment variable is undefined.

-

- Own Id: OTP-12342

- - -

- It is now possible to paste text in JCL mode (using - Ctrl-Y) that has been copied in the previous shell - session. Also a bug that caused the JCL mode to crash - when pasting text has been fixed.

-

- Own Id: OTP-12673

- - -
- - -
Improvements and New Features - - -

- New BIF: erlang:get_keys/0, lists all keys - associated with the process dictionary. Note: - erlang:get_keys/0 is auto-imported.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-12151 Aux Id: seq12521

- - -

- The internal group to user_drv protocol has been changed - to be synchronous in order to guarantee that output sent - to a process implementing the user_drv protocol is - printed before replying. This protocol is used by the - standard_output device and the ssh application when - acting as a client.

-

- This change changes the previous unlimited buffer when - printing to standard_io and other devices that end up in - user_drv to 1KB.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-12240

- - -

The inflateInit/2 and deflateInit/6 - functions now accepts a WindowBits argument equal to 8 - and -8.

-

- Own Id: OTP-12564

- - -
- -
-
Kernel 3.2
Fixed Bugs and Malfunctions diff --git a/lib/kernel/vsn.mk b/lib/kernel/vsn.mk index c912da0091..e1d447a465 100644 --- a/lib/kernel/vsn.mk +++ b/lib/kernel/vsn.mk @@ -1 +1 @@ -KERNEL_VSN = 4.0 +KERNEL_VSN = 3.2 diff --git a/lib/mnesia/doc/src/notes.xml b/lib/mnesia/doc/src/notes.xml index 7f6ff1e655..dc98efbff3 100644 --- a/lib/mnesia/doc/src/notes.xml +++ b/lib/mnesia/doc/src/notes.xml @@ -38,37 +38,7 @@ thus constitutes one section in this document. The title of each section is the version number of Mnesia.

-
Mnesia 4.13 - -
Fixed Bugs and Malfunctions - - -

- Mnesia's dirty functions did not always exit with - {aborted, Reason} as documented when an error - occurred.

-

- Own Id: OTP-12714

- - -
- - -
Improvements and New Features - - -

- Make Mnesia DCD dump behavior at start up optional, when - turned off mnesia loads large disc_copies tables faster.

-

- Own Id: OTP-12481

- - -
- -
- -
Mnesia 4.12.5 +
Mnesia 4.12.5
Fixed Bugs and Malfunctions diff --git a/lib/mnesia/vsn.mk b/lib/mnesia/vsn.mk index 79dd495c4b..b23339e408 100644 --- a/lib/mnesia/vsn.mk +++ b/lib/mnesia/vsn.mk @@ -1 +1 @@ -MNESIA_VSN = 4.13 +MNESIA_VSN = 4.12.5 diff --git a/lib/observer/doc/src/notes.xml b/lib/observer/doc/src/notes.xml index 338708db43..a9ec68fc9e 100644 --- a/lib/observer/doc/src/notes.xml +++ b/lib/observer/doc/src/notes.xml @@ -31,28 +31,6 @@

This document describes the changes made to the Observer application.

-
Observer 2.1 - -
Improvements and New Features - - -

- Added the possibility to view sasl log entries for - processes.

-

- Own Id: OTP-12504

- - -

- Add memory allocator usage and utilization graphs.

-

- Own Id: OTP-12631

- - -
- -
-
Observer 2.0.4
Fixed Bugs and Malfunctions diff --git a/lib/observer/vsn.mk b/lib/observer/vsn.mk index 7e7e32099b..10ed3bdfe5 100644 --- a/lib/observer/vsn.mk +++ b/lib/observer/vsn.mk @@ -1 +1 @@ -OBSERVER_VSN = 2.1 +OBSERVER_VSN = 2.0.4 diff --git a/lib/orber/doc/src/notes.xml b/lib/orber/doc/src/notes.xml index 1ffd86a1fb..2167a43eee 100644 --- a/lib/orber/doc/src/notes.xml +++ b/lib/orber/doc/src/notes.xml @@ -33,23 +33,7 @@ -
Orber 3.8 - -
Improvements and New Features - - -

Remove the usage of erlang:now() from all Corba - applications and use the new rand module instead of - random.

-

- Own Id: OTP-12687

- - -
- -
- -
Orber 3.7.1 +
Orber 3.7.1
Fixed Bugs and Malfunctions diff --git a/lib/os_mon/doc/src/notes.xml b/lib/os_mon/doc/src/notes.xml index bd4206d748..d3acc1effc 100644 --- a/lib/os_mon/doc/src/notes.xml +++ b/lib/os_mon/doc/src/notes.xml @@ -30,25 +30,6 @@

This document describes the changes made to the OS_Mon application.

-
Os_Mon 2.4 - -
Improvements and New Features - - -

- cpu_sup should use native sysctl/libkvm calls on BSD

-

- This avoids forking off with os:cmd every time we just - want to collect the load averages. riak does this every - second, which results in a lot of unnecessary load.

-

- Own Id: OTP-12730

- - -
- -
-
Os_Mon 2.3.1
Fixed Bugs and Malfunctions diff --git a/lib/os_mon/vsn.mk b/lib/os_mon/vsn.mk index 7f2667e40a..833e855e0e 100644 --- a/lib/os_mon/vsn.mk +++ b/lib/os_mon/vsn.mk @@ -1 +1 @@ -OS_MON_VSN = 2.4 +OS_MON_VSN = 2.3.1 diff --git a/lib/parsetools/doc/src/notes.xml b/lib/parsetools/doc/src/notes.xml index 1751238d20..c8cb70b6d2 100644 --- a/lib/parsetools/doc/src/notes.xml +++ b/lib/parsetools/doc/src/notes.xml @@ -30,21 +30,6 @@

This document describes the changes made to the Parsetools application.

-
Parsetools 2.1 - -
Improvements and New Features - - -

The new -dialyzer() attribute is used for - suppressing Dialyzer warnings in generated code.

-

- Own Id: OTP-12271

- - -
- -
-
Parsetools 2.0.12
Fixed Bugs and Malfunctions diff --git a/lib/parsetools/vsn.mk b/lib/parsetools/vsn.mk index b99b3bb713..dd9cc2991c 100644 --- a/lib/parsetools/vsn.mk +++ b/lib/parsetools/vsn.mk @@ -1 +1 @@ -PARSETOOLS_VSN = 2.1 +PARSETOOLS_VSN = 2.0.12 diff --git a/lib/percept/doc/src/notes.xml b/lib/percept/doc/src/notes.xml index 19d6cd6d01..b51c8fcb4d 100644 --- a/lib/percept/doc/src/notes.xml +++ b/lib/percept/doc/src/notes.xml @@ -32,21 +32,6 @@

This document describes the changes made to the Percept application.

-
Percept 0.8.11 - -
Fixed Bugs and Malfunctions - - -

- Fix http server configuration

-

- Own Id: OTP-12662

- - -
- -
-
Percept 0.8.10
Fixed Bugs and Malfunctions diff --git a/lib/percept/vsn.mk b/lib/percept/vsn.mk index 833ab35aa5..4451354e21 100644 --- a/lib/percept/vsn.mk +++ b/lib/percept/vsn.mk @@ -1 +1 @@ -PERCEPT_VSN = 0.8.11 +PERCEPT_VSN = 0.8.10 diff --git a/lib/public_key/doc/src/notes.xml b/lib/public_key/doc/src/notes.xml index df65ad7004..f241a91eb0 100644 --- a/lib/public_key/doc/src/notes.xml +++ b/lib/public_key/doc/src/notes.xml @@ -34,37 +34,6 @@ notes.xml -
Public_Key 1.0 - -
Improvements and New Features - - -

- public_key: Remove legacy switch compact_bit_string

-

- E.i bitstrings will not be decode as {Unused, Binary}, - they are now Erlang bitstrings.

-

- Also the compact_bit_string implies the - legacy_erlang_types switch So removing the switch will - also make OCTET STRING values be represented as binaries.

-

- Undecoded open type will now be wrapped in a - asn1_OPENTYPE tuple.

-

- This will change some values in records returned by the - public_key API making this change a potentiall - incompatibility.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-12110

- - -
- -
-
Public_Key 0.23
Improvements and New Features diff --git a/lib/sasl/doc/src/notes.xml b/lib/sasl/doc/src/notes.xml index c0ac0cf79c..95d7c6fa50 100644 --- a/lib/sasl/doc/src/notes.xml +++ b/lib/sasl/doc/src/notes.xml @@ -30,30 +30,6 @@

This document describes the changes made to the SASL application.

-
SASL 2.4.2 - -
Fixed Bugs and Malfunctions - - -

- The undocumented upgrade instruction - {remove_module,PrePurge,PostPurge,DepMods} is - removed. This instruction was added for symmetry reasons - in OTP R7B, but was never documented or tested.

-

- The existing instruction {add_module,Mod,DepMods} - is now documented, and the complementing instruction - {delete_module,Mod,DepMods} is added.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-11540

- - -
- -
-
SASL 2.4.1
Fixed Bugs and Malfunctions diff --git a/lib/sasl/vsn.mk b/lib/sasl/vsn.mk index 8d1a043410..4259a2d76c 100644 --- a/lib/sasl/vsn.mk +++ b/lib/sasl/vsn.mk @@ -1 +1 @@ -SASL_VSN = 2.4.2 +SASL_VSN = 2.4.1 diff --git a/lib/ssh/doc/src/notes.xml b/lib/ssh/doc/src/notes.xml index af5b78bff2..41885c684c 100644 --- a/lib/ssh/doc/src/notes.xml +++ b/lib/ssh/doc/src/notes.xml @@ -29,72 +29,6 @@ notes.xml -
Ssh 4.0 - -
Fixed Bugs and Malfunctions - - -

- Included test of the 'e' and 'f' parameters in dh key - exchange as specified in rfc 4253 section 8.

-

- Own Id: OTP-12649

- - -

- Fixes the bug that once the rekey_limit bytes (by - default, 1GB) had been transmitted the connection was - rekeyed every minute, not after the next 'rekey_limit'.

-

- Thanks to Simon Cornish for the report and the fix!

-

- Own Id: OTP-12692

- - -

- Fixes a bug that causes an SFTP connection to always fail - when {timeout, Timeout} option is used with - ssh_sftp:start_channel.

-

- Thanks to Simon Cornish

-

- Own Id: OTP-12708

- - -
- - -
Improvements and New Features - - -

- The internal group to user_drv protocol has been changed - to be synchronous in order to guarantee that output sent - to a process implementing the user_drv protocol is - printed before replying. This protocol is used by the - standard_output device and the ssh application when - acting as a client.

-

- This change changes the previous unlimited buffer when - printing to standard_io and other devices that end up in - user_drv to 1KB.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-12240

- - -

- If ssh_connection:subsystem/4 fails we do not want to - crash but rather terminate gracefully.

-

- Own Id: OTP-12648 Aux Id: seq12834

- - -
- -
-
Ssh 3.2.2
Improvements and New Features diff --git a/lib/ssl/doc/src/notes.xml b/lib/ssl/doc/src/notes.xml index e0992d317c..352563700b 100644 --- a/lib/ssl/doc/src/notes.xml +++ b/lib/ssl/doc/src/notes.xml @@ -25,68 +25,7 @@ notes.xml

This document describes the changes made to the SSL application.

-
SSL 7.0 - -
Fixed Bugs and Malfunctions - - -

- Ignore signature_algorithm (TLS 1.2 extension) sent to - TLS 1.0 or TLS 1.1 server

-

- Own Id: OTP-12670

- - -
- - -
Improvements and New Features - - -

- Add new API functions to handle CRL-verification

-

- Own Id: OTP-10362 Aux Id: kunagi-215 [126]

- - -

- Remove default support for SSL-3.0, due to Poodle - vunrability in protocol specification.

-

- Add padding check for TLS-1.0 to remove Poodle - vunrability from TLS 1.0, also add the option - padding_check. This option only affects TLS-1.0 - connections and if set to false it disables the block - cipher padding check to be able to interoperate with - legacy software.

-

- Remove default support for RC4 cipher suites, as they are - consider too weak.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-12390

- - -

- Add support for TLS ALPN (Application-Layer Protocol - Negotiation) extension.

-

- Own Id: OTP-12580

- - -

- Add SNI (Server Name Indication) support for the server - side.

-

- Own Id: OTP-12736

- - -
- -
- -
SSL 6.0 +
SSL 6.0
Fixed Bugs and Malfunctions diff --git a/lib/stdlib/doc/src/notes.xml b/lib/stdlib/doc/src/notes.xml index 3914a9bc0e..301a5ee2e8 100644 --- a/lib/stdlib/doc/src/notes.xml +++ b/lib/stdlib/doc/src/notes.xml @@ -30,224 +30,6 @@

This document describes the changes made to the STDLIB application.

-
STDLIB 2.5 - -
Fixed Bugs and Malfunctions - - -

- Fix handling of single dot in filename:join/2

-

- The reference manual says that filename:join(A,B) is - equivalent to filename:join([A,B]). In some rare cases - this turns out not to be true. For example:

-

- filename:join("/a/.","b") -> "/a/./b" vs - filename:join(["/a/.","b"]) -> "/a/b".

-

- This has been corrected. A single dot is now only kept if - it occurs at the very beginning or the very end of the - resulting path.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-12158

- - -

- The undocumented option generic_debug for - gen_server has been removed.

-

- Own Id: OTP-12183

- - -

- erl_lint:icrt_export/4 has been rewritten to make the - code really follow the scoping rules of Erlang, and not - just in most situations by accident.

-

- Own Id: OTP-12186

- - -

- Add 'trim_all' option to binary:split/3

-

- This option can be set to remove _ALL_ empty parts of the - result of a call to binary:split/3.

-

- Own Id: OTP-12301

- - -

Correct orddict(3) regarding evaluation order of - fold() and map().

-

- Own Id: OTP-12651 Aux Id: seq12832

- - -

- Correct maps module error exceptions

-

- Bad input to maps module function will now yield the - following exceptions: {badmap,NotMap} - or, badarg

-

- Own Id: OTP-12657

- - -

- It is now possible to paste text in JCL mode (using - Ctrl-Y) that has been copied in the previous shell - session. Also a bug that caused the JCL mode to crash - when pasting text has been fixed.

-

- Own Id: OTP-12673

- - -
- - -
Improvements and New Features - - -

- Allow maps for supervisor flags and child specs

-

- Earlier, supervisor flags and child specs were given as - tuples. While this is kept for backwards compatibility, - it is now also allowed to give these parameters as maps, - see sup_flags - and child_spec.

-

- Own Id: OTP-11043

- - -

- A new system message, terminate, is added. This - can be sent with sys:terminate/2,3. If the - receiving process handles system messages properly it - will terminate shortly after receiving this message.

-

- The new function proc_lib:stop/1,3 utilizes this - new system message and monitors the receiving process in - order to facilitate a synchronous stop mechanism for - 'special processes'.

-

- proc_lib:stop/1,3 is used by the following - functions:

-

- gen_server:stop/1,3 (new) - gen_fsm:stop/1,3 (new) - gen_event:stop/1,3 (modified to be - synchronous) wx_object:stop/1,3 - (new)

-

- Own Id: OTP-11173 Aux Id: seq12353

- - -

- Remove the pg module, which has been deprecated - through OTP-17, is now removed from the STDLIB - application. This module has been marked experimental for - more than 15 years, and has largely been superseded by - the pg2 module from the Kernel application.

-

- Own Id: OTP-11907

- - -

- New BIF: erlang:get_keys/0, lists all keys - associated with the process dictionary. Note: - erlang:get_keys/0 is auto-imported.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-12151 Aux Id: seq12521

- - -

Add three new functions to io_lib-- - scan_format/2, unscan_format/1, and - build_text/1-- which expose the parsed form of the - format control sequences to make it possible to easily - modify or filter the input to io_lib:format/2. - This can e.g. be used in order to replace unbounded-size - control sequences like ~w or ~p with - corresponding depth-limited ~W and ~P - before doing the actual formatting.

-

- Own Id: OTP-12167

- - -

Introduce the erl_anno module, an abstraction - of the second element of tokens and tuples in the - abstract format.

-

- Own Id: OTP-12195

- - -

- Support variables as Map keys in expressions and patterns

-

Erlang will accept any expression as keys in Map - expressions and it will accept literals or bound - variables as keys in Map patterns.

-

- Own Id: OTP-12218

- - -

The last traces of Mnemosyne Rules have been removed. -

-

- Own Id: OTP-12257

- - -

- Properly support maps in match_specs

-

- Own Id: OTP-12270

- - -

- New function ets:take/2. Works the same as - ets:delete/2 but also returns the deleted - object(s).

-

- Own Id: OTP-12309

- - -

string:tokens/2 is somewhat faster, especially - if the list of separators only contains one separator - character.

-

- Own Id: OTP-12422 Aux Id: seq12774

- - -

- Prevent zip:zip_open/[12] from leaking file descriptors - if parent process dies.

-

- Own Id: OTP-12566

- - -

- Add a new random number generator, see rand - module. It have better characteristics and an improved - interface.

-

- Own Id: OTP-12586 Aux Id: OTP-12501, OTP-12502

- - -

filename:split/1 when given an empty binary - will now return an empty list, to make it consistent with - return value when given an empty list.

-

- Own Id: OTP-12716

- - -
- -
-
STDLIB 2.4
Fixed Bugs and Malfunctions diff --git a/lib/stdlib/vsn.mk b/lib/stdlib/vsn.mk index a1f2a946b1..f57f31c8de 100644 --- a/lib/stdlib/vsn.mk +++ b/lib/stdlib/vsn.mk @@ -1 +1 @@ -STDLIB_VSN = 2.5 +STDLIB_VSN = 2.4 diff --git a/lib/syntax_tools/doc/src/notes.xml b/lib/syntax_tools/doc/src/notes.xml index 8f245083c4..408f6d5bac 100644 --- a/lib/syntax_tools/doc/src/notes.xml +++ b/lib/syntax_tools/doc/src/notes.xml @@ -31,20 +31,6 @@

This document describes the changes made to the Syntax_Tools application.

-
Syntax_Tools 1.7 - -
Improvements and New Features - - -

Use the new erl_anno module.

-

- Own Id: OTP-12732

- - -
- -
-
Syntax_Tools 1.6.18
Fixed Bugs and Malfunctions diff --git a/lib/syntax_tools/vsn.mk b/lib/syntax_tools/vsn.mk index 403e90196e..1c42ef0ddb 100644 --- a/lib/syntax_tools/vsn.mk +++ b/lib/syntax_tools/vsn.mk @@ -1 +1 @@ -SYNTAX_TOOLS_VSN = 1.7 +SYNTAX_TOOLS_VSN = 1.6.18 diff --git a/lib/test_server/doc/src/notes.xml b/lib/test_server/doc/src/notes.xml index 6cf7a2b52d..e996d2b4a3 100644 --- a/lib/test_server/doc/src/notes.xml +++ b/lib/test_server/doc/src/notes.xml @@ -32,55 +32,6 @@ notes.xml -
Test_Server 3.9 - -
Fixed Bugs and Malfunctions - - -

- The status of an aborted test due to test suite - compilation error has changed from 'auto_skipped' to - 'failed'. This affects both the textual log file, event - handling and CT hook callbacks. The logging of - compilation failures has also been improved, especially - in the case of multiple test suites failing compilation.

-

- Own Id: OTP-10816

- - -
- - -
Improvements and New Features - - -

- The Test Server application has been marked as obsolete - and will be removed from OTP in the next major release - (OTP 19.0).

-

- Own Id: OTP-10923 Aux Id: OTP-12705

- - -

- When running OTP tests using the ts interface, it is now - possible to specify so called test categories per OTP - application. A test category is represented by a CT test - specification and defines an arbitrary subset of existing - test suites, groups and cases. Examples of test - categories are 'smoke' (smoke tests) and 'bench' - (benchmarks). (Call ts:help() for more info). Also, - functions for reading terms from the current test - specification during test, ct:get_testspec_terms/0 and - ct:get_testspec_terms/1, have been implemented.

-

- Own Id: OTP-11962

- - -
- -
-
Test_Server 3.8.1
Fixed Bugs and Malfunctions diff --git a/lib/tools/doc/src/notes.xml b/lib/tools/doc/src/notes.xml index 85610d623a..38b57b73a9 100644 --- a/lib/tools/doc/src/notes.xml +++ b/lib/tools/doc/src/notes.xml @@ -30,65 +30,6 @@

This document describes the changes made to the Tools application.

-
Tools 2.8 - -
Fixed Bugs and Malfunctions - - -

- In order to improve performance of the cover tool, new - functions are added for cover compilation and analysis on - multiple files. This allows for more parallelisation.

-

- Some improvements of the data base access is also done in - order to improve the performance when analysing and - resetting cover data.

-

- Minor incompatibility: An error reason from - analyse_to_file is changed from no_source_code_found to - {no_source_code_found,Module}.

-

- *** POTENTIAL INCOMPATIBILITY ***

-

- Own Id: OTP-12330 Aux Id: seq12757

- - -
- - -
Improvements and New Features - - -

- Allow maps for supervisor flags and child specs

-

- Earlier, supervisor flags and child specs were given as - tuples. While this is kept for backwards compatibility, - it is now also allowed to give these parameters as maps, - see sup_flags - and child_spec.

-

- Own Id: OTP-11043

- - -

- Remove Mnemosyne rules support.

-

- Own Id: OTP-12511

- - -

- Add printout of total number of calls and time in eprof

-

- Own Id: OTP-12681

- - -
- -
-
Tools 2.7.2
Fixed Bugs and Malfunctions diff --git a/lib/tools/vsn.mk b/lib/tools/vsn.mk index 68c3f6e29c..3b3202d38b 100644 --- a/lib/tools/vsn.mk +++ b/lib/tools/vsn.mk @@ -1 +1 @@ -TOOLS_VSN = 2.8 +TOOLS_VSN = 2.7.2 diff --git a/lib/typer/doc/src/notes.xml b/lib/typer/doc/src/notes.xml index 045b55ffe4..23e22759d6 100644 --- a/lib/typer/doc/src/notes.xml +++ b/lib/typer/doc/src/notes.xml @@ -30,20 +30,6 @@

This document describes the changes made to TypEr.

-
TypEr 0.9.9 - -
Fixed Bugs and Malfunctions - - -

Properly extract annotations from core code.

-

- Own Id: OTP-12727

- - -
- -
-
TypEr 0.9.8
Fixed Bugs and Malfunctions diff --git a/lib/typer/vsn.mk b/lib/typer/vsn.mk index 74c0ccfc59..ce658e257b 100644 --- a/lib/typer/vsn.mk +++ b/lib/typer/vsn.mk @@ -1 +1 @@ -TYPER_VSN = 0.9.9 +TYPER_VSN = 0.9.8 diff --git a/lib/webtool/doc/src/notes.xml b/lib/webtool/doc/src/notes.xml index 4800dd6df4..e571668c91 100644 --- a/lib/webtool/doc/src/notes.xml +++ b/lib/webtool/doc/src/notes.xml @@ -31,23 +31,6 @@

This document describes the changes made to the Webtool application.

-
WebTool 0.9 - -
Improvements and New Features - - -

- The Webtool application has been marked as obsolete and - will be removed from OTP in the next major release (OTP - 19.0).

-

- Own Id: OTP-10922 Aux Id: OTP-12705

- - -
- -
-
WebTool 0.8.10
Fixed Bugs and Malfunctions diff --git a/lib/wx/doc/src/notes.xml b/lib/wx/doc/src/notes.xml index d31e927458..682ab48ca0 100644 --- a/lib/wx/doc/src/notes.xml +++ b/lib/wx/doc/src/notes.xml @@ -31,55 +31,6 @@

This document describes the changes made to the wxErlang application.

-
Wx 1.4 - -
Fixed Bugs and Malfunctions - - -

- The undocumented option generic_debug for - gen_server has been removed.

-

- Own Id: OTP-12183

- - -
- - -
Improvements and New Features - - -

- Use wxWidgets-3.0, if found, as default backend on - windows.

-

- Own Id: OTP-12632

- - -

- Add missing fields in some events records. May require a - recompilation of user applications.

-

- Own Id: OTP-12660

- - -
- - -
Known Bugs and Problems - - -

- Remove raise condition where wx could crash during - emulator stoppage.

-

- Own Id: OTP-12734

- - -
- -
-
Wx 1.3.3
Fixed Bugs and Malfunctions diff --git a/lib/wx/vsn.mk b/lib/wx/vsn.mk index 09fb9f384c..942d4c0d6f 100644 --- a/lib/wx/vsn.mk +++ b/lib/wx/vsn.mk @@ -1 +1 @@ -WX_VSN = 1.4 +WX_VSN = 1.3.3 diff --git a/lib/xmerl/doc/src/notes.xml b/lib/xmerl/doc/src/notes.xml index b9cc2bd329..3fa1f01a79 100644 --- a/lib/xmerl/doc/src/notes.xml +++ b/lib/xmerl/doc/src/notes.xml @@ -31,20 +31,6 @@

This document describes the changes made to the Xmerl application.

-
Xmerl 1.3.8 - -
Fixed Bugs and Malfunctions - - -

Remove compiler warnings in xmerl.

-

- Own Id: OTP-12689

- - -
- -
-
Xmerl 1.3.7
Fixed Bugs and Malfunctions -- cgit v1.2.3 From 6477f1ddad8cb2e8eb8336cda15fbb14d7fa8e93 Mon Sep 17 00:00:00 2001 From: Peter Andersson Date: Wed, 13 May 2015 11:23:26 +0200 Subject: Fix failing test case and handling double functions on one line --- lib/test_server/src/erl2html2.erl | 12 ++++++------ lib/test_server/test/erl2html2_SUITE.erl | 31 +++++++++++++++++++------------ 2 files changed, 25 insertions(+), 18 deletions(-) (limited to 'lib') diff --git a/lib/test_server/src/erl2html2.erl b/lib/test_server/src/erl2html2.erl index 9101212852..acab8dfa52 100644 --- a/lib/test_server/src/erl2html2.erl +++ b/lib/test_server/src/erl2html2.erl @@ -188,18 +188,18 @@ build_html(SFd,DFd,Encoding,FuncsAndCs) -> build_html(SFd,DFd,Encoding,file:read_line(SFd),1,FuncsAndCs, false,undefined). -%% function start line found -build_html(SFd,DFd,Enc,{ok,Str},L0,[{F,A,L0,LastL}|FuncsAndCs], - _IsFuncDef,_FAndLastL) -> - FALink = test_server_ctrl:uri_encode(F++"-"++integer_to_list(A),utf8), - file:write(DFd,[""]), - build_html(SFd,DFd,Enc,{ok,Str},L0,FuncsAndCs,true,{F,LastL}); %% line of last expression in function found build_html(SFd,DFd,Enc,{ok,Str},LastL,FuncsAndCs,_IsFuncDef,{F,LastL}) -> LastLineLink = test_server_ctrl:uri_encode(F++"-last_expr",utf8), file:write(DFd,[""]), build_html(SFd,DFd,Enc,{ok,Str},LastL,FuncsAndCs,true,undefined); +%% function start line found +build_html(SFd,DFd,Enc,{ok,Str},L0,[{F,A,L0,LastL}|FuncsAndCs], + _IsFuncDef,_FAndLastL) -> + FALink = test_server_ctrl:uri_encode(F++"-"++integer_to_list(A),utf8), + file:write(DFd,[""]), + build_html(SFd,DFd,Enc,{ok,Str},L0,FuncsAndCs,true,{F,LastL}); build_html(SFd,DFd,Enc,{ok,Str},L,[{clause,L}|FuncsAndCs], _IsFuncDef,FAndLastL) -> build_html(SFd,DFd,Enc,{ok,Str},L,FuncsAndCs,true,FAndLastL); diff --git a/lib/test_server/test/erl2html2_SUITE.erl b/lib/test_server/test/erl2html2_SUITE.erl index 908985c879..7001b6086d 100644 --- a/lib/test_server/test/erl2html2_SUITE.erl +++ b/lib/test_server/test/erl2html2_SUITE.erl @@ -232,33 +232,40 @@ check_line_number(Last,Line,OrigLine) -> check_link_targets(Src,Dst,L,RmFncs) -> Mod = list_to_atom(filename:basename(filename:rootname(Src))), Exports = Mod:module_info(exports)--[{module_info,0},{module_info,1}|RmFncs], - {ok,{[],L},_} = xmerl_sax_parser:file(Dst, - [{event_fun,fun sax_event/3}, - {event_state,{Exports,0}}]), + LastExprFuncs = [Func || {Func,_A} <- Exports], + {ok,{[],[],L},_} = + xmerl_sax_parser:file(Dst, + [{event_fun,fun sax_event/3}, + {event_state,{Exports,LastExprFuncs,0}}]), ok. sax_event(Event,_Loc,State) -> sax_event(Event,State). -sax_event({startElement,_Uri,"a",_QN,Attrs},{Exports,PrevLine}) -> +sax_event({startElement,_Uri,"a",_QN,Attrs},{Exports,LastExprFuncs,PrevLine}) -> {_,_,"name",Name} = lists:keyfind("name",3,Attrs), case catch list_to_integer(Name) of Line when is_integer(Line) -> case PrevLine + 1 of Line -> -% erlang:display({found_line,Line}), - {Exports,Line}; + {Exports,LastExprFuncs,Line}; Other -> ct:fail({unexpected_line_number_target,Other}) end; {'EXIT',_} -> - {match,[FStr,AStr]} = - re:run(Name,"^(.*)-([0-9]+)$",[{capture,all_but_first,list}]), + {match,[FStr,EndStr]} = + re:run(Name,"^(.*)-(last_expr|[0-9]+)$", + [{capture,all_but_first,list}]), F = list_to_atom(http_uri:decode(FStr)), - A = list_to_integer(AStr), -% erlang:display({found_fnc,F,A}), - A = proplists:get_value(F,Exports), - {lists:delete({F,A},Exports),PrevLine} + case EndStr of + "last_expr" -> + true = lists:member(F,LastExprFuncs), + {Exports,lists:delete(F,LastExprFuncs),PrevLine}; + _ -> + A = list_to_integer(EndStr), + A = proplists:get_value(F,Exports), + {lists:delete({F,A},Exports),LastExprFuncs,PrevLine} + end end; sax_event(_,State) -> State. -- cgit v1.2.3 From 7aef211a66219b6fef9d0bdaf9b09be6c2e0a32f Mon Sep 17 00:00:00 2001 From: Hans Nilsson Date: Tue, 12 May 2015 17:03:28 +0200 Subject: ssh: option for handling the SSH_MSG_DEBUG message's printouts A fun could be given in the options that will be called whenever the SSH_MSG_DEBUG message arrives. This enables the user to format the printout or just discard it. The default is changed to not print the message. In RFC4253 printing is a SHOULD, but our new default is to protect logs from dos attacs. --- lib/ssh/doc/src/ssh.xml | 20 +++++++- lib/ssh/src/ssh.erl | 4 ++ lib/ssh/src/ssh_connection_handler.erl | 12 ++--- lib/ssh/test/ssh_basic_SUITE.erl | 90 ++++++++++++++++++++++++++++++++++ lib/ssh/vsn.mk | 2 +- 5 files changed, 119 insertions(+), 9 deletions(-) (limited to 'lib') diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml index 72dafc0c09..501668ca78 100644 --- a/lib/ssh/doc/src/ssh.xml +++ b/lib/ssh/doc/src/ssh.xml @@ -201,6 +201,14 @@

Sets a timeout on connection when no channels are active, default is infinity

 + + _}]]> + +

Provide a fun to implement your own logging of the SSH message SSH_MSG_DEBUG. The last three parameters are from the message, see RFC4253, section 11.3. The ConnectionRef is the reference to the connection on which the message arrived. The return value from the fun is not checked.

+

The default behaviour is ignore the message. + To get a printout for each message with AlwaysDisplay = true, use for example {ssh_msg_debug_fun, fun(_,true,M,_)-> io:format("DEBUG: ~p~n", [M]) end}

+ + @@ -383,8 +391,16 @@

Provide a fun to implement your own logging when a user disconnects from the server.

 - - + + _}]]> + +

Provide a fun to implement your own logging of the SSH message SSH_MSG_DEBUG. The last three parameters are from the message, see RFC4253, section 11.3. The ConnectionRef is the reference to the connection on which the message arrived. The return value from the fun is not checked.

+

The default behaviour is ignore the message. + To get a printout for each message with AlwaysDisplay = true, use for example {ssh_msg_debug_fun, fun(_,true,M,_)-> io:format("DEBUG: ~p~n", [M]) end}

+ + + + diff --git a/lib/ssh/src/ssh.erl b/lib/ssh/src/ssh.erl index d4b02a024e..71e7d77475 100644 --- a/lib/ssh/src/ssh.erl +++ b/lib/ssh/src/ssh.erl @@ -312,6 +312,8 @@ handle_option([{disconnectfun, _} = Opt | Rest], SocketOptions, SshOptions) -> handle_option(Rest, SocketOptions, [handle_ssh_option(Opt) | SshOptions]); handle_option([{failfun, _} = Opt | Rest], SocketOptions, SshOptions) -> handle_option(Rest, SocketOptions, [handle_ssh_option(Opt) | SshOptions]); +handle_option([{ssh_msg_debug_fun, _} = Opt | Rest], SocketOptions, SshOptions) -> + handle_option(Rest, SocketOptions, [handle_ssh_option(Opt) | SshOptions]); %%Backwards compatibility should not be underscore between ip and v6 in API handle_option([{ip_v6_disabled, Value} | Rest], SocketOptions, SshOptions) -> handle_option(Rest, SocketOptions, [handle_ssh_option({ipv6_disabled, Value}) | SshOptions]); @@ -417,6 +419,8 @@ handle_ssh_option({disconnectfun , Value} = Opt) when is_function(Value) -> Opt; handle_ssh_option({failfun, Value} = Opt) when is_function(Value) -> Opt; +handle_ssh_option({ssh_msg_debug_fun, Value} = Opt) when is_function(Value,4) -> + Opt; handle_ssh_option({ipv6_disabled, Value} = Opt) when is_boolean(Value) -> throw({error, {{ipv6_disabled, Opt}, option_no_longer_valid_use_inet_option_instead}}); diff --git a/lib/ssh/src/ssh_connection_handler.erl b/lib/ssh/src/ssh_connection_handler.erl index e1f2e059e8..0f6162db60 100644 --- a/lib/ssh/src/ssh_connection_handler.erl +++ b/lib/ssh/src/ssh_connection_handler.erl @@ -580,12 +580,12 @@ handle_event(#ssh_msg_disconnect{description = Desc} = DisconnectMsg, _StateName handle_event(#ssh_msg_ignore{}, StateName, State) -> {next_state, StateName, next_packet(State)}; -handle_event(#ssh_msg_debug{always_display = true, message = DbgMsg}, - StateName, State) -> - io:format("DEBUG: ~p\n", [DbgMsg]), - {next_state, StateName, next_packet(State)}; - -handle_event(#ssh_msg_debug{}, StateName, State) -> +handle_event(#ssh_msg_debug{always_display = Display, message = DbgMsg, language=Lang}, + StateName, #state{opts = Opts} = State) -> + F = proplists:get_value(ssh_msg_debug_fun, Opts, + fun(_ConnRef, _AlwaysDisplay, _Msg, _Language) -> ok end + ), + catch F(self(), Display, DbgMsg, Lang), {next_state, StateName, next_packet(State)}; handle_event(#ssh_msg_unimplemented{}, StateName, State) -> diff --git a/lib/ssh/test/ssh_basic_SUITE.erl b/lib/ssh/test/ssh_basic_SUITE.erl index f5f8991acc..fa7b426545 100644 --- a/lib/ssh/test/ssh_basic_SUITE.erl +++ b/lib/ssh/test/ssh_basic_SUITE.erl @@ -52,6 +52,8 @@ all() -> ssh_connect_arg4_timeout, packet_size_zero, ssh_daemon_minimal_remote_max_packet_size_option, + ssh_msg_debug_fun_option_client, + ssh_msg_debug_fun_option_server, id_string_no_opt_client, id_string_own_string_client, id_string_random_client, @@ -493,6 +495,94 @@ server_userpassword_option(Config) when is_list(Config) -> {user_dir, UserDir}]), ssh:stop_daemon(Pid). +%%-------------------------------------------------------------------- +ssh_msg_debug_fun_option_client() -> + [{doc, "validate client that uses the 'ssh_msg_debug_fun' option"}]. +ssh_msg_debug_fun_option_client(Config) -> + PrivDir = ?config(priv_dir, Config), + UserDir = filename:join(PrivDir, nopubkey), % to make sure we don't use public-key-auth + file:make_dir(UserDir), + SysDir = ?config(data_dir, Config), + + {Pid, Host, Port} = ssh_test_lib:daemon([{system_dir, SysDir}, + {user_dir, UserDir}, + {password, "morot"}, + {failfun, fun ssh_test_lib:failfun/2}]), + Parent = self(), + DbgFun = fun(ConnRef,Displ,Msg,Lang) -> Parent ! {msg_dbg,{ConnRef,Displ,Msg,Lang}} end, + + ConnectionRef = + ssh_test_lib:connect(Host, Port, [{silently_accept_hosts, true}, + {user, "foo"}, + {password, "morot"}, + {user_dir, UserDir}, + {user_interaction, false}, + {ssh_msg_debug_fun,DbgFun}]), + %% Beware, implementation knowledge: + gen_fsm:send_all_state_event(ConnectionRef,{ssh_msg_debug,false,<<"Hello">>,<<>>}), + receive + {msg_dbg,X={ConnectionRef,false,<<"Hello">>,<<>>}} -> + ct:log("Got expected dbg msg ~p",[X]), + ssh:stop_daemon(Pid); + {msg_dbg,X={_,false,<<"Hello">>,<<>>}} -> + ct:log("Got dbg msg but bad ConnectionRef (~p expected) ~p",[ConnectionRef,X]), + ssh:stop_daemon(Pid), + {fail, "Bad ConnectionRef received"}; + {msg_dbg,X} -> + ct:log("Got bad dbg msg ~p",[X]), + ssh:stop_daemon(Pid), + {fail,"Bad msg received"} + after 1000 -> + ssh:stop_daemon(Pid), + {fail,timeout} + end. + +%%-------------------------------------------------------------------- +ssh_msg_debug_fun_option_server() -> + [{doc, "validate client that uses the 'ssh_msg_debug_fun' option"}]. +ssh_msg_debug_fun_option_server(Config) -> + PrivDir = ?config(priv_dir, Config), + UserDir = filename:join(PrivDir, nopubkey), % to make sure we don't use public-key-auth + file:make_dir(UserDir), + SysDir = ?config(data_dir, Config), + + Parent = self(), + DbgFun = fun(ConnRef,Displ,Msg,Lang) -> Parent ! {msg_dbg,{ConnRef,Displ,Msg,Lang}} end, + ConnFun = fun(_,_,_) -> Parent ! {connection_pid,self()} end, + + {Pid, Host, Port} = ssh_test_lib:daemon([{system_dir, SysDir}, + {user_dir, UserDir}, + {password, "morot"}, + {failfun, fun ssh_test_lib:failfun/2}, + {connectfun, ConnFun}, + {ssh_msg_debug_fun, DbgFun}]), + _ConnectionRef = + ssh_test_lib:connect(Host, Port, [{silently_accept_hosts, true}, + {user, "foo"}, + {password, "morot"}, + {user_dir, UserDir}, + {user_interaction, false}]), + receive + {connection_pid,Server} -> + %% Beware, implementation knowledge: + gen_fsm:send_all_state_event(Server,{ssh_msg_debug,false,<<"Hello">>,<<>>}), + receive + {msg_dbg,X={_,false,<<"Hello">>,<<>>}} -> + ct:log("Got expected dbg msg ~p",[X]), + ssh:stop_daemon(Pid); + {msg_dbg,X} -> + ct:log("Got bad dbg msg ~p",[X]), + ssh:stop_daemon(Pid), + {fail,"Bad msg received"} + after 3000 -> + ssh:stop_daemon(Pid), + {fail,timeout2} + end + after 3000 -> + ssh:stop_daemon(Pid), + {fail,timeout1} + end. + %%-------------------------------------------------------------------- known_hosts() -> [{doc, "check that known_hosts is updated correctly"}]. diff --git a/lib/ssh/vsn.mk b/lib/ssh/vsn.mk index b2b85a717f..40bda0c19f 100644 --- a/lib/ssh/vsn.mk +++ b/lib/ssh/vsn.mk @@ -1,4 +1,4 @@ #-*-makefile-*- ; force emacs to enter makefile-mode -SSH_VSN = 3.2.2 +SSH_VSN = 3.2.3 APP_VSN = "ssh-$(SSH_VSN)" -- cgit v1.2.3 From 42cf8b8ca9daec40a3595034a15f9f4be1cc854b Mon Sep 17 00:00:00 2001 From: Peter Andersson Date: Wed, 13 May 2015 15:56:11 +0200 Subject: Fix problem not recognizing 'macro' tuple from epp_dodger OTP-12740 --- lib/test_server/src/erl2html2.erl | 6 +++- lib/test_server/test/erl2html2_SUITE.erl | 39 ++++++++++++---------- .../test/erl2html2_SUITE_data/include/header3.hrl | 1 + lib/test_server/test/erl2html2_SUITE_data/m1.erl | 6 ++++ 4 files changed, 34 insertions(+), 18 deletions(-) create mode 100644 lib/test_server/test/erl2html2_SUITE_data/include/header3.hrl (limited to 'lib') diff --git a/lib/test_server/src/erl2html2.erl b/lib/test_server/src/erl2html2.erl index acab8dfa52..b0b5c40965 100644 --- a/lib/test_server/src/erl2html2.erl +++ b/lib/test_server/src/erl2html2.erl @@ -170,7 +170,11 @@ get_line(Anno) -> %%% Find the line number of the last expression in the function find_clause_lines([{clause,CL,_Params,_Op,Exprs}], CLs) -> % last clause try tuple_to_list(lists:last(Exprs)) of - [_Type,ExprLine | _] -> + [_Type,ExprLine | _] when is_integer(ExprLine) -> + {lists:reverse([{clause,get_line(CL)}|CLs]), get_line(ExprLine)}; + [tree,_ | Exprs1] -> + find_clause_lines([{clause,CL,undefined,undefined,Exprs1}], CLs); + [macro,{_var,ExprLine,_MACRO} | _] when is_integer(ExprLine) -> {lists:reverse([{clause,get_line(CL)}|CLs]), get_line(ExprLine)}; _ -> {lists:reverse([{clause,get_line(CL)}|CLs]), get_line(CL)} diff --git a/lib/test_server/test/erl2html2_SUITE.erl b/lib/test_server/test/erl2html2_SUITE.erl index 7001b6086d..796b84dedd 100644 --- a/lib/test_server/test/erl2html2_SUITE.erl +++ b/lib/test_server/test/erl2html2_SUITE.erl @@ -130,15 +130,7 @@ groups() -> %% @end %%-------------------------------------------------------------------- all() -> - [m1]. - -%%-------------------------------------------------------------------- -%% @spec TestCase() -> Info -%% Info = [tuple()] -%% @end -%%-------------------------------------------------------------------- -m1() -> - []. + [macros_defined, macros_undefined]. %%-------------------------------------------------------------------- %% @spec TestCase(Config0) -> @@ -149,19 +141,29 @@ m1() -> %% Comment = term() %% @end %%-------------------------------------------------------------------- -m1(Config) -> - {Src,Dst} = convert_module("m1",Config), +macros_defined(Config) -> + %% let erl2html2 use epp as parser + DataDir = ?config(data_dir,Config), + InclDir = filename:join(DataDir, "include"), + {Src,Dst} = convert_module("m1",[InclDir],Config), + {true,L} = check_line_numbers(Src,Dst), + ok = check_link_targets(Src,Dst,L,[{baz,0}],[]), + ok. + +macros_undefined(Config) -> + %% let erl2html2 use epp_dodger as parser + {Src,Dst} = convert_module("m1",[],Config), {true,L} = check_line_numbers(Src,Dst), - ok = check_link_targets(Src,Dst,L,[{baz,0}]), + ok = check_link_targets(Src,Dst,L,[{baz,0}],[{quux,0}]), ok. -convert_module(Mod,Config) -> +convert_module(Mod,InclDirs,Config) -> DataDir = ?config(data_dir,Config), PrivDir = ?config(priv_dir,Config), Src = filename:join(DataDir,Mod++".erl"), Dst = filename:join(PrivDir,Mod++".erl.html"), io:format("~s\n",[Src,filename:basename(Src)]), - ok = erl2html2:convert(Src, Dst, [], ""), + ok = erl2html2:convert(Src, Dst, InclDirs, ""), io:format("~s\n",[Dst,filename:basename(Dst)]), {Src,Dst}. @@ -229,14 +231,17 @@ check_line_number(Last,Line,OrigLine) -> %% function. %% The test module has -compile(export_all), so all functions are %% found by listing the exported ones. -check_link_targets(Src,Dst,L,RmFncs) -> +check_link_targets(Src,Dst,L,RmFncs,ShouldRemain) -> Mod = list_to_atom(filename:basename(filename:rootname(Src))), Exports = Mod:module_info(exports)--[{module_info,0},{module_info,1}|RmFncs], LastExprFuncs = [Func || {Func,_A} <- Exports], - {ok,{[],[],L},_} = + {ok,{FAs,Fs,L},_} = xmerl_sax_parser:file(Dst, [{event_fun,fun sax_event/3}, - {event_state,{Exports,LastExprFuncs,0}}]), + {event_state,{Exports,LastExprFuncs,0}}]), + true = (length(FAs) == length(ShouldRemain)), + [] = [FA || FA <- FAs, not lists:member(FA,ShouldRemain)], + [] = [F || F <- Fs, not lists:keymember(F,1,ShouldRemain)], ok. sax_event(Event,_Loc,State) -> diff --git a/lib/test_server/test/erl2html2_SUITE_data/include/header3.hrl b/lib/test_server/test/erl2html2_SUITE_data/include/header3.hrl new file mode 100644 index 0000000000..2a20850a3a --- /dev/null +++ b/lib/test_server/test/erl2html2_SUITE_data/include/header3.hrl @@ -0,0 +1 @@ +-define(EPP_SWITCH, on). diff --git a/lib/test_server/test/erl2html2_SUITE_data/m1.erl b/lib/test_server/test/erl2html2_SUITE_data/m1.erl index 156f1d0a51..1d405963a5 100644 --- a/lib/test_server/test/erl2html2_SUITE_data/m1.erl +++ b/lib/test_server/test/erl2html2_SUITE_data/m1.erl @@ -7,9 +7,15 @@ -include("header1.hrl"). -include("header2.hrl"). +-include("header3.hrl"). -define(MACRO1,value). +%% This macro is used to select parser in erl2html2. +%% If EPP_SWITCH is defined epp is used, else epp_dodger. +epp_switch() -> + ?EPP_SWITCH. + %%% Comment foo(x) -> %% Comment -- cgit v1.2.3 From 3b46b3040b82436c904f497bd51cda79a181b500 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Wed, 13 May 2015 16:39:13 +0200 Subject: ssl: Align "=" sign in type declarations to decided policy --- lib/ssl/doc/src/ssl.xml | 12 ++++++------ lib/ssl/doc/src/ssl_crl_cache_api.xml | 8 ++++---- lib/ssl/doc/src/ssl_session_cache_api.xml | 20 ++++++++++---------- 3 files changed, 20 insertions(+), 20 deletions(-) (limited to 'lib') diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml index 8a0bf69be4..18d98e5efb 100644 --- a/lib/ssl/doc/src/ssl.xml +++ b/lib/ssl/doc/src/ssl.xml @@ -123,13 +123,13 @@ The callback gen_tcp is treated specially and calls inet directly.

- CallbackModule -

= atom()

 - DataTag -

= atom()

+ CallbackModule = +

atom()

 + DataTag = +

atom()

Used in socket data message.

 - ClosedTag -

= atom()

+ ClosedTag = +

atom()

Used in socket close message.

 diff --git a/lib/ssl/doc/src/ssl_crl_cache_api.xml b/lib/ssl/doc/src/ssl_crl_cache_api.xml index 90aa895aff..9230442ae0 100644 --- a/lib/ssl/doc/src/ssl_crl_cache_api.xml +++ b/lib/ssl/doc/src/ssl_crl_cache_api.xml @@ -47,10 +47,10 @@ - cache_ref() - = opaque() - dist_point() -

= #'DistributionPoint'{} see cache_ref() = + opaque() + dist_point() = +

#'DistributionPoint'{} see X509 certificates records

 diff --git a/lib/ssl/doc/src/ssl_session_cache_api.xml b/lib/ssl/doc/src/ssl_session_cache_api.xml index c89d3874a1..28b5f4ce23 100644 --- a/lib/ssl/doc/src/ssl_session_cache_api.xml +++ b/lib/ssl/doc/src/ssl_session_cache_api.xml @@ -40,20 +40,20 @@ ssl_session_cache_api:

- cache_ref() -

= opaque()

 + cache_ref() = +

opaque()

 - key() -

= {partialkey(), session_id()}

 + key() = +

{partialkey(), session_id()}

 - partialkey() -

= opaque()

 + partialkey() = +

opaque()

 - session_id() -

= binary()

 + session_id() = +

binary()

 - session() -

= opaque()

 + session() = +

opaque()
-- cgit v1.2.3 From ddc4e717df1da722682b6ccdbf152a6b7e15f378 Mon Sep 17 00:00:00 2001 From: beaver Date: Wed, 25 Mar 2015 18:03:26 +0300 Subject: stdlib: Add gb_trees:iterator_from --- lib/stdlib/doc/src/gb_trees.xml | 13 +++++++++- lib/stdlib/src/gb_trees.erl | 31 ++++++++++++++++++++++-- lib/stdlib/test/dict_SUITE.erl | 50 +++++++++++++++++++++++++++++++++++---- lib/stdlib/test/dict_test_lib.erl | 5 +++- 4 files changed, 91 insertions(+), 8 deletions(-) (limited to 'lib') diff --git a/lib/stdlib/doc/src/gb_trees.xml b/lib/stdlib/doc/src/gb_trees.xml index b2f237e1d7..82167e1083 100644 --- a/lib/stdlib/doc/src/gb_trees.xml +++ b/lib/stdlib/doc/src/gb_trees.xml @@ -4,7 +4,7 @@
- 20012014 + 20012015 Ericsson AB. All Rights Reserved. @@ -182,6 +182,17 @@ memory at one time.

+ + + Return an iterator for a tree starting from specified key + +

Returns an iterator that can be used for traversing the + entries of Tree; see next/1. + The difference as compared to the iterator returned by + iterator/1 is that the first key greater than + or equal to Key is returned.

+ + Return a list of the keys in a tree diff --git a/lib/stdlib/src/gb_trees.erl b/lib/stdlib/src/gb_trees.erl index 7069b61873..259e8f718b 100644 --- a/lib/stdlib/src/gb_trees.erl +++ b/lib/stdlib/src/gb_trees.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2001-2014. All Rights Reserved. +%% Copyright Ericsson AB 2001-2015. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -102,6 +102,10 @@ %% approach is that it does not require the complete list of all %% elements to be built in memory at one time. %% +%% - iterator_from(K, T): returns an iterator that can be used for +%% traversing the entries of tree T with key greater than or +%% equal to K; see `next'. +%% %% - next(S): returns {X, V, S1} where X is the smallest key referred to %% by the iterator S, and S1 is the new iterator to be used for %% traversing the remaining entries, or the atom `none' if no entries @@ -117,7 +121,7 @@ update/3, enter/3, delete/2, delete_any/2, balance/1, is_defined/2, keys/1, values/1, to_list/1, from_orddict/1, smallest/1, largest/1, take_smallest/1, take_largest/1, - iterator/1, next/1, map/2]). + iterator/1, iterator_from/2, next/1, map/2]). %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -529,6 +533,29 @@ iterator({_, _, L, _} = T, As) -> iterator(nil, As) -> As. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +-spec iterator_from(Key, Tree) -> Iter when + Tree :: tree(Key, Value), + Iter :: iter(Key, Value). + +iterator_from(S, {_, T}) -> + iterator_1_from(S, T). + +iterator_1_from(S, T) -> + iterator_from(S, T, []). + +iterator_from(S, {K, _, _, T}, As) when K < S -> + iterator_from(S, T, As); +iterator_from(_, {_, _, nil, _} = T, As) -> + [T | As]; +iterator_from(S, {_, _, L, _} = T, As) -> + iterator_from(S, L, [T | As]); +iterator_from(_, nil, As) -> + As. + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + -spec next(Iter1) -> 'none' | {Key, Value, Iter2} when Iter1 :: iter(Key, Value), Iter2 :: iter(Key, Value). diff --git a/lib/stdlib/test/dict_SUITE.erl b/lib/stdlib/test/dict_SUITE.erl index 69814e12ce..ab624e8dd2 100644 --- a/lib/stdlib/test/dict_SUITE.erl +++ b/lib/stdlib/test/dict_SUITE.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2008-2013. All Rights Reserved. +%% Copyright Ericsson AB 2008-2015. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -25,16 +25,16 @@ -export([all/0, suite/0,groups/0,init_per_suite/1, end_per_suite/1, init_per_group/2,end_per_group/2, init_per_testcase/2,end_per_testcase/2, - create/1,store/1]). + create/1,store/1,iterate/1]). -include_lib("test_server/include/test_server.hrl"). --import(lists, [foldl/3,reverse/1]). +-import(lists, [foldl/3]). suite() -> [{ct_hooks,[ts_install_cth]}]. all() -> - [create, store]. + [create, store, iterate]. groups() -> []. @@ -92,6 +92,48 @@ store_1(List, M) -> end, D0. +%%% +%%% Test specifics for gb_trees. +%%% + +iterate(Config) when is_list(Config) -> + test_all(fun iterate_1/1). + +iterate_1(M) -> + case M(module, []) of + gb_trees -> iterate_2(M); + _ -> ok + end, + M(empty, []). + +iterate_2(M) -> + random:seed(1, 2, 42), + iter_tree(M, 1000). + +iter_tree(_M, 0) -> + ok; +iter_tree(M, N) -> + L = [{I, I} || I <- lists:seq(1, N)], + T = M(from_list, L), + L = lists:reverse(iterate_tree(M, T)), + R = random:uniform(N), + KV = lists:reverse(iterate_tree_from(M, R, T)), + KV = [P || P={K,_} <- L, K >= R], + iter_tree(M, N-1). + +iterate_tree(M, Tree) -> + I = M(iterator, Tree), + iterate_tree_1(M, M(next, I), []). + +iterate_tree_from(M, Start, Tree) -> + I = M(iterator_from, {Start, Tree}), + iterate_tree_1(M, M(next, I), []). + +iterate_tree_1(_, none, R) -> + R; +iterate_tree_1(M, {K, V, I}, R) -> + iterate_tree_1(M, M(next, I), [{K, V} | R]). + %%% %%% Helper functions. %%% diff --git a/lib/stdlib/test/dict_test_lib.erl b/lib/stdlib/test/dict_test_lib.erl index 4fdb4fa0bd..81d26ce5f8 100644 --- a/lib/stdlib/test/dict_test_lib.erl +++ b/lib/stdlib/test/dict_test_lib.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2008-2013. All Rights Reserved. +%% Copyright Ericsson AB 2008-2015. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -29,6 +29,9 @@ new(Mod, Eq) -> (module, []) -> Mod; (size, D) -> Mod:size(D); (is_empty, D) -> Mod:is_empty(D); + (iterator, S) -> Mod:iterator(S); + (iterator_from, {Start, S}) -> Mod:iterator_from(Start, S); + (next, I) -> Mod:next(I); (to_list, D) -> to_list(Mod, D) end. -- cgit v1.2.3 From f584a60d0e5a6fa0a8002a13e8dda2a790031427 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 12 May 2015 14:15:40 +0200 Subject: stdlib: Add gb_sets:iterator_from --- lib/stdlib/doc/src/gb_sets.xml | 13 +++++++++++- lib/stdlib/src/gb_sets.erl | 24 +++++++++++++++++++-- lib/stdlib/test/sets_SUITE.erl | 44 ++++++++++++++++++++++++++++++++++++--- lib/stdlib/test/sets_test_lib.erl | 5 ++++- 4 files changed, 79 insertions(+), 7 deletions(-) (limited to 'lib') diff --git a/lib/stdlib/doc/src/gb_sets.xml b/lib/stdlib/doc/src/gb_sets.xml index ea96c14472..405bae5698 100644 --- a/lib/stdlib/doc/src/gb_sets.xml +++ b/lib/stdlib/doc/src/gb_sets.xml @@ -4,7 +4,7 @@
- 20012014 + 20012015 Ericsson AB. All Rights Reserved. @@ -305,6 +305,17 @@ memory at one time.

+ + + Return an iterator for a set starting from a specified element + +

Returns an iterator that can be used for traversing the + entries of Set; see next/1. + The difference as compared to the iterator returned by + iterator/1 is that the first element greater than + or equal to Element is returned.

+ + Return largest element diff --git a/lib/stdlib/src/gb_sets.erl b/lib/stdlib/src/gb_sets.erl index 393fb07229..d3fbd542f7 100644 --- a/lib/stdlib/src/gb_sets.erl +++ b/lib/stdlib/src/gb_sets.erl @@ -137,6 +137,10 @@ %% approach is that it does not require the complete list of all %% elements to be built in memory at one time. %% +%% - iterator_from(X, S): returns an iterator that can be used for +%% traversing the elements of set S greater than or equal to X; +%% see `next'. +%% %% - next(T): returns {X, T1} where X is the smallest element referred %% to by the iterator T, and T1 is the new iterator to be used for %% traversing the remaining elements, or the atom `none' if no @@ -157,8 +161,8 @@ insert/2, add/2, delete/2, delete_any/2, balance/1, union/2, union/1, intersection/2, intersection/1, is_disjoint/2, difference/2, is_subset/2, to_list/1, from_list/1, from_ordset/1, smallest/1, - largest/1, take_smallest/1, take_largest/1, iterator/1, next/1, - filter/2, fold/3, is_set/1]). + largest/1, take_smallest/1, take_largest/1, iterator/1, + iterator_from/2, next/1, filter/2, fold/3, is_set/1]). %% `sets' compatibility aliases: @@ -500,6 +504,22 @@ iterator({_, L, _} = T, As) -> iterator(nil, As) -> As. +-spec iterator_from(Element, Set) -> Iter when + Set :: set(Element), + Iter :: iter(Element). + +iterator_from(S, {_, T}) -> + iterator_from(S, T, []). + +iterator_from(S, {K, _, T}, As) when K < S -> + iterator_from(S, T, As); +iterator_from(_, {_, nil, _} = T, As) -> + [T | As]; +iterator_from(S, {_, L, _} = T, As) -> + iterator_from(S, L, [T | As]); +iterator_from(_, nil, As) -> + As. + -spec next(Iter1) -> {Element, Iter2} | 'none' when Iter1 :: iter(Element), Iter2 :: iter(Element). diff --git a/lib/stdlib/test/sets_SUITE.erl b/lib/stdlib/test/sets_SUITE.erl index c0cf1fc7e8..24f5d65f82 100644 --- a/lib/stdlib/test/sets_SUITE.erl +++ b/lib/stdlib/test/sets_SUITE.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2004-2013. All Rights Reserved. +%% Copyright Ericsson AB 2004-2015. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -28,7 +28,7 @@ create/1,add_element/1,del_element/1, subtract/1,intersection/1,union/1,is_subset/1, is_set/1,fold/1,filter/1, - take_smallest/1,take_largest/1]). + take_smallest/1,take_largest/1, iterate/1]). -include_lib("test_server/include/test_server.hrl"). @@ -48,7 +48,7 @@ suite() -> [{ct_hooks,[ts_install_cth]}]. all() -> [create, add_element, del_element, subtract, intersection, union, is_subset, is_set, fold, filter, - take_smallest, take_largest]. + take_smallest, take_largest, iterate]. groups() -> []. @@ -426,6 +426,44 @@ take_largest_3(S0, List0, M) -> take_largest_3(S, List, M) end. +iterate(Config) when is_list(Config) -> + test_all(fun iterate_1/1). + +iterate_1(M) -> + case M(module, []) of + gb_sets -> iterate_2(M); + _ -> ok + end, + M(empty, []). + +iterate_2(M) -> + random:seed(1, 2, 42), + iter_set(M, 1000). + +iter_set(_M, 0) -> + ok; +iter_set(M, N) -> + L = [I || I <- lists:seq(1, N)], + T = M(from_list, L), + L = lists:reverse(iterate_set(M, T)), + R = random:uniform(N), + S = lists:reverse(iterate_set(M, R, T)), + S = [E || E <- L, E >= R], + iter_set(M, N-1). + +iterate_set(M, Set) -> + I = M(iterator, Set), + iterate_set_1(M, M(next, I), []). + +iterate_set(M, Start, Set) -> + I = M(iterator_from, {Start, Set}), + iterate_set_1(M, M(next, I), []). + +iterate_set_1(_, none, R) -> + R; +iterate_set_1(M, {E, I}, R) -> + iterate_set_1(M, M(next, I), [E | R]). + %%% %%% Helper functions. %%% diff --git a/lib/stdlib/test/sets_test_lib.erl b/lib/stdlib/test/sets_test_lib.erl index 86f009a8f9..772139406d 100644 --- a/lib/stdlib/test/sets_test_lib.erl +++ b/lib/stdlib/test/sets_test_lib.erl @@ -1,7 +1,7 @@ %% %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2004-2013. All Rights Reserved. +%% Copyright Ericsson AB 2004-2015. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -34,7 +34,10 @@ new(Mod, Eq) -> (is_empty, S) -> is_empty(Mod, S); (is_set, S) -> Mod:is_set(S); (is_subset, {S,Set}) -> is_subset(Mod, Eq, S, Set); + (iterator, S) -> Mod:iterator(S); + (iterator_from, {Start, S}) -> Mod:iterator_from(Start, S); (module, []) -> Mod; + (next, I) -> Mod:next(I); (singleton, E) -> singleton(Mod, E); (size, S) -> Mod:size(S); (subtract, {S1,S2}) -> subtract(Mod, S1, S2); -- cgit v1.2.3 From ba0608d66d7b66d9108f79afd3c7c23b0ba06194 Mon Sep 17 00:00:00 2001 From: Erlang/OTP Date: Mon, 18 May 2015 09:55:10 +0200 Subject: Update release notes --- lib/inets/doc/src/notes.xml | 17 ++++++++++++++++- lib/ssh/doc/src/notes.xml | 19 +++++++++++++++++++ 2 files changed, 35 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/inets/doc/src/notes.xml b/lib/inets/doc/src/notes.xml index 12bbc2b736..bae8e327a3 100644 --- a/lib/inets/doc/src/notes.xml +++ b/lib/inets/doc/src/notes.xml @@ -32,7 +32,22 @@ notes.xml
-
Inets 5.10.7 +
Inets 5.10.8 + +
Fixed Bugs and Malfunctions + + +

+ Reject messages with a Content-Length less than 0

+

+ Own Id: OTP-12739 Aux Id: seq12860

+ + +
+ +
+ +
Inets 5.10.7
Improvements and New Features diff --git a/lib/ssh/doc/src/notes.xml b/lib/ssh/doc/src/notes.xml index 41885c684c..579a3ae4a8 100644 --- a/lib/ssh/doc/src/notes.xml +++ b/lib/ssh/doc/src/notes.xml @@ -29,6 +29,25 @@ notes.xml
+
Ssh 3.2.3 + +
Fixed Bugs and Malfunctions + + +

+ A new option for handling the SSH_MSG_DEBUG message's + printouts. A fun could be given in the options that will + be called whenever the SSH_MSG_DEBUG message arrives. + This enables the user to format the printout or just + discard it.

+

+ Own Id: OTP-12738 Aux Id: seq12860

+ + +
+ +
+
Ssh 3.2.2
Improvements and New Features -- cgit v1.2.3 From c604ae034a79c3ca8d084de432b51af2affb2c48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Thu, 14 May 2015 22:10:32 +0200 Subject: stdlib: Add maps:filter/2 --- lib/stdlib/src/maps.erl | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/stdlib/src/maps.erl b/lib/stdlib/src/maps.erl index 3877c150ec..2913a2ff86 100644 --- a/lib/stdlib/src/maps.erl +++ b/lib/stdlib/src/maps.erl @@ -19,7 +19,8 @@ -module(maps). --export([get/3,fold/3, map/2, size/1, +-export([get/3,filter/2,fold/3, map/2, + size/1, without/2, with/2]). @@ -145,6 +146,19 @@ get(Key,Map,Default) -> erlang:error({badmap,Map},[Key,Map,Default]). +-spec filter(Pred,Map1) -> Map2 when + Pred :: fun((Key, Value) -> boolean()), + Key :: term(), + Value :: term(), + Map1 :: map(), + Map2 :: map(). + +filter(Pred,Map) when is_function(Pred,2), is_map(Map) -> + maps:from_list([{K,V}||{K,V}<-maps:to_list(Map),Pred(K,V)]); +filter(Pred,Map) -> + erlang:error(error_type(Map),[Pred,Map]). + + -spec fold(Fun,Init,Map) -> Acc when Fun :: fun((K, V, AccIn) -> AccOut), Init :: term(), -- cgit v1.2.3 From fc1967b11a65690c9ea8274c7c7fda94f7a338fa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Mon, 18 May 2015 10:19:24 +0200 Subject: stdlib: Document maps:filter/2 --- lib/stdlib/doc/src/maps.xml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'lib') diff --git a/lib/stdlib/doc/src/maps.xml b/lib/stdlib/doc/src/maps.xml index e46068230a..7345a9357a 100644 --- a/lib/stdlib/doc/src/maps.xml +++ b/lib/stdlib/doc/src/maps.xml @@ -32,6 +32,28 @@ + + + Choose pairs which satisfy a predicate + +

+ Returns a map Map2 for which predicate + Pred holds true in Map1. +

+

+ The call will fail with a {badmap,Map} exception if + Map1 is not a map or with badarg if + Pred is not a function of arity 2. +

+

Example:

+ +> M = #{a => 2, b => 3, c=> 4, "a" => 1, "b" => 2, "c" => 4}, + Pred = fun(K,V) -> is_atom(K) andalso (V rem 2) =:= 0 end, + maps:filter(Pred,M). +#{a => 2,c => 4} + + + -- cgit v1.2.3 From ed64f612197b13b556125200244ae1778aacaae2 Mon Sep 17 00:00:00 2001 From: Ingela Anderton Andin Date: Thu, 19 Mar 2015 15:28:14 +0100 Subject: ssl: Adjust sleep time in test case Adjust time to make sure "enough" time has elapsed. Will have to do for now. --- lib/ssl/test/ssl_basic_SUITE.erl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'lib') diff --git a/lib/ssl/test/ssl_basic_SUITE.erl b/lib/ssl/test/ssl_basic_SUITE.erl index 50d5fb411f..3495b978b7 100644 --- a/lib/ssl/test/ssl_basic_SUITE.erl +++ b/lib/ssl/test/ssl_basic_SUITE.erl @@ -3445,7 +3445,7 @@ renegotiate_immediately(Socket) -> end, ok = ssl:renegotiate(Socket), {error, renegotiation_rejected} = ssl:renegotiate(Socket), - ct:sleep(?RENEGOTIATION_DISABLE_TIME +1), + ct:sleep(?RENEGOTIATION_DISABLE_TIME + ?SLEEP), ok = ssl:renegotiate(Socket), ct:log("Renegotiated again"), ssl:send(Socket, "Hello world"), -- cgit v1.2.3 From 3290512efb630ac319dc893a264a16e2aef9fdc1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Mon, 18 May 2015 10:26:40 +0200 Subject: stdlib: Test maps:filter/2 --- lib/stdlib/test/maps_SUITE.erl | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'lib') diff --git a/lib/stdlib/test/maps_SUITE.erl b/lib/stdlib/test/maps_SUITE.erl index 1d9c041a74..21e146ae3d 100644 --- a/lib/stdlib/test/maps_SUITE.erl +++ b/lib/stdlib/test/maps_SUITE.erl @@ -34,7 +34,7 @@ -export([init_per_testcase/2]). -export([end_per_testcase/2]). --export([t_get_3/1, +-export([t_get_3/1, t_filter_2/1, t_fold_3/1,t_map_2/1,t_size_1/1, t_with_2/1,t_without_2/1]). @@ -45,7 +45,7 @@ suite() -> [{ct_hooks, [ts_install_cth]}]. all() -> - [t_get_3, + [t_get_3,t_filter_2, t_fold_3,t_map_2,t_size_1, t_with_2,t_without_2]. @@ -99,6 +99,16 @@ t_with_2(_Config) -> ?badarg(with,[a,#{}]) = (catch maps:with(a,#{})), ok. +t_filter_2(Config) when is_list(Config) -> + M = #{a => 2, b => 3, c=> 4, "a" => 1, "b" => 2, "c" => 4}, + Pred1 = fun(K,V) -> is_atom(K) andalso (V rem 2) =:= 0 end, + Pred2 = fun(K,V) -> is_list(K) andalso (V rem 2) =:= 0 end, + #{a := 2,c := 4} = maps:filter(Pred1,M), + #{"b" := 2,"c" := 4} = maps:filter(Pred2,M), + %% error case + ?badmap(a,filter,[_,a]) = (catch maps:filter(fun(_,_) -> ok end,id(a))), + ?badarg(filter,[<<>>,#{}]) = (catch maps:filter(id(<<>>),#{})), + ok. t_fold_3(Config) when is_list(Config) -> Vs = lists:seq(1,200), -- cgit v1.2.3 From 48bd85fdfc0648facfc76078f8556a00b4f6febb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Mon, 18 May 2015 10:29:59 +0200 Subject: stdlib: Use lc to implement maps:map/2 --- lib/stdlib/src/maps.erl | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) (limited to 'lib') diff --git a/lib/stdlib/src/maps.erl b/lib/stdlib/src/maps.erl index 2913a2ff86..533ff08726 100644 --- a/lib/stdlib/src/maps.erl +++ b/lib/stdlib/src/maps.erl @@ -183,10 +183,7 @@ fold(Fun,Init,Map) -> V2 :: term(). map(Fun,Map) when is_function(Fun, 2), is_map(Map) -> - maps:from_list(lists:map(fun - ({K,V}) -> - {K,Fun(K,V)} - end,maps:to_list(Map))); + maps:from_list([{K,Fun(K,V)}||{K,V}<-maps:to_list(Map)]); map(Fun,Map) -> erlang:error(error_type(Map),[Fun,Map]). -- cgit v1.2.3 From d1851f267d96e41a0dc8f2d123ec5e5fef514518 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 19 May 2015 12:58:23 +0200 Subject: dialyzer: Document dialyzer:gui() option 'check_plt' * Mention the option 'check_plt' among gui() options. * No longer check a PLT twice when the analysis type is 'plt_check'. * No longer raise a case_clause error when checking a PLT finds warnings. Thanks to James Fish. --- lib/dialyzer/doc/src/dialyzer.xml | 1 + lib/dialyzer/src/dialyzer.erl | 39 +++++++++--------- lib/dialyzer/test/plt_SUITE.erl | 85 +++++++++++++++++++++++++++++++++++---- 3 files changed, 97 insertions(+), 28 deletions(-) (limited to 'lib') diff --git a/lib/dialyzer/doc/src/dialyzer.xml b/lib/dialyzer/doc/src/dialyzer.xml index 2a8bf6edcc..5f52906625 100644 --- a/lib/dialyzer/doc/src/dialyzer.xml +++ b/lib/dialyzer/doc/src/dialyzer.xml @@ -368,6 +368,7 @@ Option :: {files, [Filename :: string()]} | {include_dirs, [DirName :: string()]} | {output_file, FileName :: string()} | {output_plt, FileName :: string()} + | {check_plt, boolean()}, | {analysis_type, 'succ_typings' | 'plt_add' | 'plt_build' | diff --git a/lib/dialyzer/src/dialyzer.erl b/lib/dialyzer/src/dialyzer.erl index c9e7da9ef0..c8537e3bd8 100644 --- a/lib/dialyzer/src/dialyzer.erl +++ b/lib/dialyzer/src/dialyzer.erl @@ -2,7 +2,7 @@ %%----------------------------------------------------------------------- %% %CopyrightBegin% %% -%% Copyright Ericsson AB 2006-2014. All Rights Reserved. +%% Copyright Ericsson AB 2006-2015. All Rights Reserved. %% %% The contents of this file are subject to the Erlang Public License, %% Version 1.1, (the "License"); you may not use this file except in @@ -162,14 +162,7 @@ run(Opts) -> {error, Msg} -> throw({dialyzer_error, Msg}); OptsRecord -> - case OptsRecord#options.check_plt of - true -> - case cl_check_init(OptsRecord) of - {ok, ?RET_NOTHING_SUSPICIOUS} -> ok; - {error, ErrorMsg1} -> throw({dialyzer_error, ErrorMsg1}) - end; - false -> ok - end, + ok = check_init(OptsRecord), case dialyzer_cl:start(OptsRecord) of {?RET_DISCREPANCIES, Warnings} -> Warnings; {?RET_NOTHING_SUSPICIOUS, _} -> [] @@ -179,6 +172,16 @@ run(Opts) -> erlang:error({dialyzer_error, lists:flatten(ErrorMsg)}) end. +check_init(#options{analysis_type = plt_check}) -> + ok; +check_init(#options{check_plt = true} = OptsRecord) -> + case cl_check_init(OptsRecord) of + {ok, _} -> ok; + {error, Msg} -> throw({dialyzer_error, Msg}) + end; +check_init(#options{check_plt = false}) -> + ok. + internal_gui(OptsRecord) -> F = fun() -> dialyzer_gui_wx:start(OptsRecord), @@ -199,17 +202,13 @@ gui(Opts) -> throw({dialyzer_error, Msg}); OptsRecord -> ok = check_gui_options(OptsRecord), - case cl_check_init(OptsRecord) of - {ok, ?RET_NOTHING_SUSPICIOUS} -> - F = fun() -> - dialyzer_gui_wx:start(OptsRecord) - end, - case doit(F) of - {ok, _} -> ok; - {error, Msg} -> throw({dialyzer_error, Msg}) - end; - {error, ErrorMsg1} -> - throw({dialyzer_error, ErrorMsg1}) + ok = check_init(OptsRecord), + F = fun() -> + dialyzer_gui_wx:start(OptsRecord) + end, + case doit(F) of + {ok, _} -> ok; + {error, Msg} -> throw({dialyzer_error, Msg}) end catch throw:{dialyzer_error, ErrorMsg} -> diff --git a/lib/dialyzer/test/plt_SUITE.erl b/lib/dialyzer/test/plt_SUITE.erl index ef4cdc57f0..ecbac14e5d 100644 --- a/lib/dialyzer/test/plt_SUITE.erl +++ b/lib/dialyzer/test/plt_SUITE.erl @@ -6,12 +6,13 @@ -include_lib("common_test/include/ct.hrl"). -include("dialyzer_test_constants.hrl"). --export([suite/0, all/0, build_plt/1, beam_tests/1, update_plt/1]). +-export([suite/0, all/0, build_plt/1, beam_tests/1, update_plt/1, + run_plt_check/1, run_succ_typings/1]). suite() -> [{timetrap, ?plt_timeout}]. -all() -> [build_plt, beam_tests, update_plt]. +all() -> [build_plt, beam_tests, update_plt, run_plt_check, run_succ_typings]. build_plt(Config) -> OutDir = ?config(priv_dir, Config), @@ -37,14 +38,76 @@ beam_tests(Config) when is_list(Config) -> ">>, Opts = [no_auto_import], {ok, BeamFile} = compile(Config, Prog, no_auto_import, Opts), - [] = run_dialyzer([BeamFile]), + [] = run_dialyzer(plt_build, [BeamFile], []), ok. -run_dialyzer(Files) -> - dialyzer:run([{analysis_type, plt_build}, - {files, Files}, - {from, byte_code}, - {check_plt, false}]). +run_plt_check(Config) when is_list(Config) -> + Mod1 = <<" + -module(run_plt_check1). + ">>, + + Mod2A = <<" + -module(run_plt_check2). + ">>, + + {ok, BeamFile1} = compile(Config, Mod1, run_plt_check1, []), + {ok, BeamFile2} = compile(Config, Mod2A, run_plt_check2, []), + [] = run_dialyzer(plt_build, [BeamFile1, BeamFile2], []), + + Mod2B = <<" + -module(run_plt_check2). + + -export([call/1]). + + call(X) -> run_plt_check1:call(X). + ">>, + + {ok, BeamFile2} = compile(Config, Mod2B, run_plt_check2, []), + + % callgraph warning as run_plt_check2:call/1 makes a call to unexported + % function run_plt_check1:call/1. + [_] = run_dialyzer(plt_check, [], []), + + ok. + +run_succ_typings(Config) when is_list(Config) -> + Mod1A = <<" + -module(run_succ_typings1). + + -export([call/0]). + + call() -> a. + ">>, + + {ok, BeamFile1} = compile(Config, Mod1A, run_succ_typings1, []), + [] = run_dialyzer(plt_build, [BeamFile1], []), + + Mod1B = <<" + -module(run_succ_typings1). + + -export([call/0]). + + call() -> b. + ">>, + + Mod2 = <<" + -module(run_succ_typings2). + + -export([call/0]). + + -spec call() -> b. + call() -> run_succ_typings1:call(). + ">>, + + {ok, BeamFile1} = compile(Config, Mod1B, run_succ_typings1, []), + {ok, BeamFile2} = compile(Config, Mod2, run_succ_typings2, []), + % contract types warning as run_succ_typings2:call/0 makes a call to + % run_succ_typings1:call/0, which returns a (not b) in the PLT. + [_] = run_dialyzer(succ_typings, [BeamFile2], [{check_plt, false}]), + % warning not returned as run_succ_typings1 is updated in the PLT. + [] = run_dialyzer(succ_typings, [BeamFile2], [{check_plt, true}]), + + ok. %%% [James Fish:] %%% If a function is removed from a module and the module has previously @@ -103,3 +166,9 @@ compile(Config, Prog, Module, CompileOpts) -> Opts = [{outdir, PrivDir}, debug_info | CompileOpts], {ok, Module} = compile:file(Filename, Opts), {ok, filename:join([PrivDir, lists:concat([Module, ".beam"])])}. + +run_dialyzer(Analysis, Files, Opts) -> + dialyzer:run([{analysis_type, Analysis}, + {files, Files}, + {from, byte_code} | + Opts]). -- cgit v1.2.3