aboutsummaryrefslogtreecommitdiff
path: root/example/data/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'example/data/README.md')
-rw-r--r--example/data/README.md179
1 files changed, 179 insertions, 0 deletions
diff --git a/example/data/README.md b/example/data/README.md
new file mode 100644
index 0000000..f1c0aa3
--- /dev/null
+++ b/example/data/README.md
@@ -0,0 +1,179 @@
+# Sample Issuer Material
+
+This folder contains sample issuer material for use with the Intel(R)
+EPID SDK. All data files are in binary format.
+
+## Directory Structure
+
+ data
+ |__ groupa
+ | |__ member0
+ | | |__ mprivkey.dat
+ | |
+ | |__ member1
+ | | |__ mprivkey.dat
+ | |
+ | |__ privrevokedmember0
+ | | |__ mprivkey.dat
+ | |
+ | |__ privrevokedmember1
+ | | |__ mprivkey.dat
+ | |
+ | |__ privrevokedmember2
+ | | |__ mprivkey.dat
+ | |
+ | |__ sigrevokedmember0
+ | | |__ mprivkey.dat
+ | |
+ | |__ sigrevokedmember1
+ | | |__ mprivkey.dat
+ | |
+ | |__ sigrevokedmember2
+ | | |__ mprivkey.dat
+ | |
+ | |__ privrl.bin
+ | |__ privrl_empty.bin
+ | |__ pubkey.bin
+ | |__ sigrl.bin
+ | |__ sigrl_empty.bin
+ |
+ |__ groupb
+ | |__ member0
+ | | |__ mprivkey.dat
+ | |
+ | |__ member1
+ | | |__ mprivkey.dat
+ | |
+ | |__ privrevokedmember0
+ | | |__ mprivkey.dat
+ | |
+ | |__ sigrevokedmember0
+ | | |__ mprivkey.dat
+ | |
+ | |__ privrl.bin
+ | |__ privrl_empty.bin
+ | |__ pubkey.bin
+ | |__ sigrl.bin
+ | |__ sigrl_empty.bin
+ |
+ |__ grprl.bin
+ |__ grprl_empty.bin
+ |__ mprivkey.dat
+ |__ privrl.bin
+ |__ pubkey.bin
+ |__ cacert.bin
+ |__ sigrl.bin
+
+
+## Description
+
+There are 2 groups
+
+- **groupa**
+
+- **groupb**
+
+
+_Note: No compressed key sample material is included in this folder._
+
+### Group A
+
+**groupa** contains 8 members. Each member has a member private key
+`mprivkey.dat`. Here are the members:
+
+- **member0** - a member in good standing
+
+- **member1** - a member in good standing
+
+- **privrevokedmember0** - a member revoked using its private key
+
+- **privrevokedmember1** - a member revoked using its private key
+
+- **privrevokedmember2** - a member revoked using its private key
+
+- **sigrevokedmember0** - a member revoked using a signature
+
+- **sigrevokedmember1** - a member revoked using a signature
+
+- **sigrevokedmember2** - a member revoked using a signature
+
+
+In addition, **groupa** contain the following revocation lists:
+
+- `pubkey.bin` - group public key
+
+- `privrl.bin` - private key based revocation list with 3 entries -
+ **privrevokedmember0**, **privrevokedmember1** and
+ **privrevokedmember2**
+
+- `sigrl.bin` - signature based revocation list with 3 entries -
+ **sigrevokedmember0**, **sigrevokedmember2** and
+ **sigrevokedmember2**
+
+- `privrl_empty.bin` - private key based revocation list with 0 entries
+
+- `sigrl_empty.bin` - signature based revocation list with 0 entries
+
+
+### Group B
+
+**groupb** contains 3 members. Each member has a member private key
+`mprivkey.dat`. Here are the members:
+
+- **member0** - a member in good standing
+
+- **privrevokedmember0** - a member whose private key is revoked
+
+- **sigrevokedmember0** - a member whose signature is revoked
+
+
+In addition, **groupb** contain the following revocation lists:
+
+- `pubkey.bin` - group public key
+
+- `privrl.bin` - private key based revocation list with 1 entry -
+ **privrevokedmember0**
+
+- `sigrl.bin` - signature based revocation list with 1 entry -
+ **sigrevokedmember0**
+
+- `privrl_empty.bin` - private key based revocation list with 0 entries
+
+- `sigrl_empty.bin` - signature based revocation list with 0 entries
+
+
+### Default files
+
+- `/data/cacert.bin` - CA certificate used as default input to signmsg
+ and `verifysig`
+
+- `/data/grprl.bin` - group revocation list with one entry **groupb** used
+ as default input to `verifysig`
+
+- `/data/pubkey.bin` - public key in **groupa** used as default input
+ to signmsg and `verifysig`
+
+- `/data/mprivkey.dat` - private key of a **member0** in the
+ **groupa** used as default input to `signmsg`
+
+- `/data/privrl.bin` - private key based revocation list in the
+ **groupa** with 0 entries used as default input to `verifysig`
+
+- `/data/sigrl.bin` - signature based revocation list in the
+ **groupa** with 0 entries used as default input to `signmsg`
+ and `verifysig`
+
+### Group revocation lists
+
+There are 2 group revocation lists:
+
+- `grprl.bin` - group revocation list with 50 entries
+
+- `grprl_empty.bin` - group revocation list with 0 entries
+
+
+### IoT Intel(R) EPID Issuing CA certificate
+
+- `/data/cacert.bin` - CA certificate used to check that revocation
+ lists and group public keys are authorized by the issuer, e.g.,
+ signed by the issuer