From: Felix Dörre <felix@dogcraft.de>
Date: Fri, 3 Apr 2015 22:46:33 +0000 (+0200)
Subject: cleanup shellscripts + README.md
X-Git-Url: https://code.wpia.club/?p=nre.git;a=commitdiff_plain;h=69a024b8652e0f0c5203954f322b79a3f0096446

cleanup shellscripts + README.md
---

diff --git a/README.md b/README.md
new file mode 100755
index 0000000..c1e90aa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# cacert-nre
+
+This is the a project that contains scripts to generate CAcerts new ( after 2015 ) root structure.
+
+You can run the whole generation process for 2015 by invoking `all.sh `.
+
+## Overview of Generating Shell Scripts
+
+The shellscripts that can be invoked (in order of `all.sh`) are:
+
+* `clear.sh` remove all previously generated keys
+* `generateKeys.sh` generate the root certificate and structure certificates (levels 0 and 1)
+* `generateTime.sh 2015` generate the sub-cas for the year 2015
+* `generateInfra.sh 2015` generate the CAcert Infrastructure keys (gigi ssl, gigi smime, signer communication, ...)
+* `verify.sh 2015` verify all keys for the year 2015
+* (optional) `generateSignerConfig.sh 2015` generate config to be deployed on cassiopeia
+
+all these scripts depend on 2 'library-scripts':
+
+* `commonFunctions` functions used all over those scripts
+* `structure` definitions of what cas and keys exist
+
+## Other Files and Folders
+
+* `CAs` configuration per structure sub-ca
+* `profiles` configuration per certificate profile
+* `selfsign.config` config for the CAs maintained by this script-collection internally
+
+## Generated Files and Folders
+* `2015/ca` generated time-based subcas for 2015
+* `2015/keys` generated infrastructure keys for 2015
+* `{root,assured,unassured,...}.ca` root CAs
+* `*.ca/key.key` the CAs private key
+* `*.ca/key.crt` the CAs certificate
+
diff --git a/all.sh b/all.sh
index 8d647a8..eb2dfec 100755
--- a/all.sh
+++ b/all.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 . ./clear.sh
 
diff --git a/commonFunctions b/commonFunctions
index 5e1ffbf..aa1daff 100755
--- a/commonFunctions
+++ b/commonFunctions
@@ -1,3 +1,4 @@
+#!/bin/bash
 . structure
 
 genKey(){ #subj, internalName
diff --git a/generateInfra.sh b/generateInfra.sh
index bcad077..c6cc9e8 100755
--- a/generateInfra.sh
+++ b/generateInfra.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 #
 set -e
 
diff --git a/generateKeys.sh b/generateKeys.sh
index 27d86a7..8ddc79c 100755
--- a/generateKeys.sh
+++ b/generateKeys.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 # this script generates a set of sample keys
 set -e
 
diff --git a/generateSignerConfig.sh b/generateSignerConfig.sh
index cffe1e3..c054500 100755
--- a/generateSignerConfig.sh
+++ b/generateSignerConfig.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 set -e
 [ "$1" == "" ] && echo "Usage: $0 <year>" && exit 1
diff --git a/generateTime.sh b/generateTime.sh
index d18c2ba..c7a98de 100755
--- a/generateTime.sh
+++ b/generateTime.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 . structure
 . commonFunctions
diff --git a/structure b/structure
index 3579257..12e4653 100755
--- a/structure
+++ b/structure
@@ -1,5 +1,5 @@
-#!/bin/sh
-DOMAIN="cacert.local"
+#!/bin/bash
+DOMAIN="cacert.org"
 KEYSIZE=4096
 PRIVATEPW="changeit"
 
diff --git a/verify.sh b/verify.sh
index bb9ff0e..472720c 100755
--- a/verify.sh
+++ b/verify.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 set -e
 [ "$1" == "" ] && echo "Usage: $0 <year>" && exit 1
 year=$1