nacl

Check-in [6154666294]
Login

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:new README
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 6154666294bc912a407ed6de31c090b2257c1573e2feabc63332d0d487262d38
User & Date: alex 2019-12-13 14:40:17
Context
2020-05-11
08:34
mirror fossil to github Leaf check-in: c27a47f70b user: alex tags: trunk
2019-12-13
14:40
new README check-in: 6154666294 user: alex tags: trunk
2019-12-10
19:03
remove rcsid; no longer required check-in: f8157ead2c user: alex tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to README.

1
2
3
4

5
6
7
8
9
10
11
12

13
14
15
16
17
18
19
20

21
22




23
24



25
26
27
28


29
30
31
32
33
34

35
36
37


38
39
40
41

42
43

44
45
46
47
48
49
50
51
52
53



54
55
56
57




58
59
60


61
62
63
64
65
66
67
68
69
70

71
72
73



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

89
90
91



92
93

94
95
96
97
98
99
100
101
102
103
104
105
106
107
This is a sample extension showing an implementation of the Tcl Extension
Architecture (TEA).  Please see the webpage

	http://www.tcl.tk/doc/tea/


for more details on TEA.  You can also read the enclosed "tea.pdf" document
for instructions on how to adapt this sample extension to your extension.

This package is a freely available open source package.  You can do
virtually anything you like with it, such as modifying it, redistributing
it, and selling it either in whole or in part.  See the file
"license.terms" for complete information.


CONTENTS
========
The following is a short description of the files you will find in
the sample extension.

Makefile.in	Makefile template.  The configure script uses this file to
		produce the final Makefile.


README		This file





README.sha	A description of the extension itself.




aclocal.m4	Generated file.  Do not edit.  Autoconf uses this as input
		when generating the final configure script.  See "tcl.m4"
		below.



configure	Generated file.  Do not edit.  This must be regenerated
		anytime configure.in or tclconfig/tcl.m4 changes.

configure.in	Configure script template.  Autoconf uses this file as input
		to produce the final configure script.


pkgIndex.tcl.in Package index template.  The configure script will use
		this file as input to create pkgIndex.tcl.



sample.c	Core Secure Hash Algorithm code.

sample.h	Header file for functions in the C files.


sha1.n		Unix nroff man page


tclsample.c	Implementation of new Tcl command "sha1".

tea.pdf		PDF file describing the current implementation of the
		Tcl Extension Architecture

tclconfig/	This directory contains various template files that build
		the configure script.  They should not need modification.

	install-sh	Program used for copying binaries and script files



			to their install locations.

	tcl.m4		Collection of Tcl autoconf macros.  Included by
			aclocal.m4 to define SC_* macros.





UNIX BUILD
==========



Building under most UNIX systems is easy, just run the configure script
and then run make. For more information about the build process, see
the tcl/unix/README file in the Tcl src dist. The following minimal
example will install the extension in the /opt/tcl directory.

	$ cd sampleextension
	$ ./configure --prefix=/opt/tcl
	$ make
	$ make install


WINDOWS BUILD
=============




The recommended method to build extensions under windows is to use the
Msys + Mingw build process. This provides a Unix-style build while
generating native Windows binaries. Using the Msys + Mingw build tools
means that you can use the same configure script as per the Unix build
to create a Makefile. See the tcl/win/README file for the URL of
the Msys + Mingw download.

If you have VC++ then you may wish to use the files in the win
subdirectory and build the extension using just VC++. These files have
been designed to be as generic as possible but will require some
additional maintenance by the project developer to synchronise with
the TEA configure.in and Makefile.in files. Instructions for using the
VC++ makefile are written in the first part of the Makefile.vc
file.


INSTALLATION
============




The installation of a TEA package is structure like so:


         $exec_prefix
          /       \
        lib       bin
         |         |
   PACKAGEx.y   (dependent .dll files on Windows)
         |
  pkgIndex.tcl (.so|.dll files)

The main .so|.dll library file gets installed in the versioned PACKAGE
directory, which is OK on all platforms because it will be directly
referenced with by 'load' in the pkgIndex.tcl file.  Dependent DLL files on
Windows must go in the bin directory (or other directory on the user's
PATH) in order for them to be found.
<
<

<
>

<
<

<
<
<
<
>

<
<
<
<

<
<
>

<
>
>
>
>

<
>
>
>

<
<
<
>
>
|
<
<

<
<
>

<
<
>
>

<

<
>

<
>
|
<
<
<
<
<
<
<
<
<
>
>
>
|

<
<
>
>
>
>

<
<
>
>

<
<
<
<

<
<
<
<
>

<
<
>
>
>

<
<
<
<
<
<

<
<
<
<
<
<
<
>

<
<
>
>
>

<
>

<
<
<
<
<
<
<
<
<
<
<
<
<


1

2
3


4




5
6




7


8
9

10
11
12
13
14

15
16
17
18



19
20
21


22


23
24


25
26
27

28

29
30

31
32









33
34
35
36
37


38
39
40
41
42


43
44
45




46




47
48


49
50
51
52






53







54
55


56
57
58
59

60
61

















    NaCl: Networking and Cryptography library (pronounced "salt")








    This directory contains a freely distributable thread-safe extension to Tcl/Tk called nacl.








SYSNOPSIS


    NaCl (pronounced "salt") is a new easy-to-use high-speed software library for
    network communication, encryption, decryption, signatures, etc. NaCl's goal is
    to provide all of the core operations needed to build higher-level cryptographic
    tools.


    Of course, other libraries already exist for these core operations. NaCl advances
    the state of the art by improving security, by improving usability, and by
    improving speed.




    For information on how to use these commands, see the examples, hints and the home
    pages at https://tcl.sowaswie.de/repos/fossil/nacl.
    





GETTING THE CODE



    The development repository is hosted at https://tcl.sowaswie.de/repos/fossil/nacl
    You are encouraged to use trunk.




COMPILING nacl


    Go to the main directory and invoke the configure script:
    









        ./configure
	make
        make test
        make install



    Since nacl is TEA-compatible you should be able to build it using the MinGW build
    environment for Windows. There is also the MSVC nmake file so you can compile the
    package with Microsoft tools.  Refer to the README in the win directory for more
    details about building on Windows.



    The compile process will build the nacl shared library suitable for loading into
    the Tcl shell using standard "package require" mechanism.










REPORTING BUGS



    Please head to https://tcl.sowaswie.de/repos/fossil/nacl/ticket and
    click on "New Ticket". Log in as anonymous and report your findings.
    If you prefer to have an individual login write Alex a mail.















HISTORY



    The core NaCl development team consists of Daniel J. Bernstein (University of
    Illinois at Chicago and Technische Universiteit Eindhoven), Tanja Lange (Technische
    Universiteit Eindhoven), and Peter Schwabe (Radboud Universiteit Nijmegen).


    The nacl tcl packge was started by Alexander Schoepe (alx.tcl@sowaswie.de).