summaryrefslogtreecommitdiff
path: root/tracwiki/BinaryPackages.trac
diff options
context:
space:
mode:
authorRob Austein <sra@hactrn.net>2021-02-14 01:55:38 +0000
committerRob Austein <sra@hactrn.net>2021-02-14 01:55:38 +0000
commitb58c60bcc4a6f3d3ccf4194ef862a808fdc3313b (patch)
treead43c2b937db286c2b3320b57066a9581264444a /tracwiki/BinaryPackages.trac
parent23bb68fe7e9cc8af176ff60b56e8a51a70f05a89 (diff)
Hack images, store outputs in git again for now
Easier to track what each script change does if we keep the before and after versions of the markdown in git too. Clean this up eventually, but simplifies development.
Diffstat (limited to 'tracwiki/BinaryPackages.trac')
-rw-r--r--tracwiki/BinaryPackages.trac126
1 files changed, 126 insertions, 0 deletions
diff --git a/tracwiki/BinaryPackages.trac b/tracwiki/BinaryPackages.trac
new file mode 100644
index 0000000..7920461
--- /dev/null
+++ b/tracwiki/BinaryPackages.trac
@@ -0,0 +1,126 @@
+[[PageOutline]]
+
+= Binary Packages for Cryptech Software and Firmware =
+
+The Cryptech Project maintains APT and Homebrew repositories
+containing packaged software for the Cryptech Alpha board for Debian
+and Ubuntu Linux and for Mac OS X. The binary packages also include
+pre-compiled images for the Alpha Board's Artix-7 FPGA, Cortex M4 ARM
+CPU, and AVR ATtiny828 MCU.
+
+== How to get APT packages for Debian Stretch, Debian Buster, Ubuntu Xenial, or Ubuntu Bionic ==
+
+* Fetch and validate the repository key. Presumably you're security
+ concious (otherwise, why are you installing this stuff?), so you may
+ want to pay attention to what `gpg --check-sig` says here.
+
+ {{{
+ $ id=37A8E93F5D7E7B9A
+ $ wget https://apt.cryptech.is/apt-gpg-key.gpg
+ $ gpg --recv-key $id
+ $ gpg --check-sig $id
+ }}}
+
+* Install the repository key. We used to use `apt-key(8)` for this,
+ these days the cool kids use the `/etc/apt/trusted.gpg.d/` directory:
+
+ {{{
+ $ sudo chown root:root apt-gpg-key.gpg
+ $ sudo mv apt-gpg-key.gpg /etc/apt/trusted.gpg.d/cryptech.gpg
+ }}}
+
+* Configure apt to use the repository. You need to add a couple of
+ entries to `/etc/apt/source.list.d/`; which entries you need to add
+ depends on which distribution you're running.
+ * For Debian Stretch, do:
+ {{{
+ $ sudo wget -q -O /etc/apt/sources.list.d/cryptech.list http://apt.cryptech.is/sources.stretch.list
+ }}}
+ * For Debian Buster, do:
+ {{{
+ $ sudo wget -q -O /etc/apt/sources.list.d/cryptech.list http://apt.cryptech.is/sources.buster.list
+ }}}
+ * For Ubuntu Xenial, do:
+ {{{
+ $ sudo wget -q -O /etc/apt/sources.list.d/cryptech.list http://apt.cryptech.is/sources.xenial.list
+ }}}
+ * For Ubuntu Bionic, do:
+ {{{
+ $ sudo wget -q -O /etc/apt/sources.list.d/cryptech.list http://apt.cryptech.is/sources.bionic.list
+ }}}
+
+
+* Update the package index.
+
+ {{{
+ $ sudo apt-get update
+ }}}
+
+* Install the `cryptech-alpha` package.
+
+ {{{
+ $ sudo apt-get install cryptech-alpha
+ }}}
+
+== Updating APT packages ==
+
+Once you've performed the steps above you should be able to upgrade to newer
+version of the code using the normal APT upgrade process:
+
+{{{
+$ sudo apt-get update
+$ sudo apt-get upgrade
+}}}
+
+== How to get Homebrew packages for Mac OS X ==
+
+* Fetch and validate the repository key. Presumably you're security
+ concious (otherwise, why are you installing this stuff?), so you may
+ want to pay attention to what `gpg --check-sig` says here.
+
+ {{{
+ $ id=37A8E93F5D7E7B9A
+ $ gpg --recv-key $id
+ $ gpg --check-sig $id
+ }}}
+
+* Configure Homebrew to use the repository.
+
+ {{{
+ $ brew tap cryptech/sw https://brew.cryptech.is/tap
+ }}}
+
+* Update the package index.
+
+ {{{
+ $ brew update
+ }}}
+
+* Check the commit signature on the cryptech-alpha package formula.
+ This is optional (Homebrew doesn't care whether you do this), but if
+ you want to know whether the formula was signed by the Cryptech
+ project, this is how to check.
+
+ {{{
+ $ brew log --max-count=1 --show-signature cryptech-alpha
+ }}}
+
+* Install the `cryptech-alpha` package. At the moment, this is only
+ available as a Homebrew source package due to licensing issues in
+ the MacOS Xcode SDK, so the installation will probably take several
+ minutes, as some of the libraries are a bit slow to compile (sorry...).
+
+ {{{
+ $ brew install cryptech-alpha
+ }}}
+
+== Updating Homebrew packages ==
+
+Once you've performed the steps above you should be able to upgrade to newer
+version of the code using the normal Homebrew upgrade process:
+
+{{{
+$ brew update
+$ brew upgrade
+$ brew cleanup
+}}}