Create PSA landing pages #301

2019-10-15T09:27:12-05:00

gilles-peskine-arm commented

2019-10-15 09:27:12 -05:00

(Migrated from github.com)

Create landing pages about the PSA Crypto API and about the driver interfaces. There isn't much content yet, but they will be updated as more becomes available. People have been asking for a page where they can check the status, so this is it.

Patater (Migrated from github.com) requested changes

2019-10-15 10:41:51 -05:00

docs/psa/accel/index.html

					
				@ -0,0 +1,5 @@

				<h1 id="psa-cryptographic-accelerator-interface">PSA cryptographic accelerator interface</h1>

HTML in commit "Check in HTML versions" will need regeneration due to the .md updates.

HTML in commit "Check in HTML versions" will need regeneration due to the `.md` updates.

docs/psa/accel/index.md

					
				@ -0,0 +1,11 @@

				# PSA cryptographic accelerator interface

- lets you drivers
+ lets you write drivers

```diff - lets you drivers + lets you write drivers ```

- into an implementation of the
+ that interfaces with an implementation of the

Although I don't like saying "interface" twice in the sentence, the sentence as written doesn't make much sense to me.

```diff - into an implementation of the + that interfaces with an implementation of the ``` Although I don't like saying "interface" twice in the sentence, the sentence as written doesn't make much sense to me.

docs/psa/entropy/index.md

					
				@ -0,0 +1,11 @@

				# PSA entropy source driver interface

- The accelerator interface lets you drivers
+ The entropy source interface lets you write drivers

```diff - The accelerator interface lets you drivers + The entropy source interface lets you write drivers ```

- into an implementation of the
+ that interfaces with an implementation of the

```diff - into an implementation of the + that interfaces with an implementation of the ```

docs/psa/index.md

					
				@ -0,0 +1,47 @@

				# PSA cryptography interfaces

- The accelerator interface lets you drivers
+ The secure element interface lets you write drivers

```diff - The accelerator interface lets you drivers + The secure element interface lets you write drivers ```

- into an implementation of the
+ that interfaces with an implementation of the

```diff - into an implementation of the + that interfaces with an implementation of the ```

- The accelerator interface
+ The entropy source interface lets you write drivers

```diff - The accelerator interface + The entropy source interface lets you write drivers ```

- into an implementation of the
+ that interfaces with an implementation of the

```diff - into an implementation of the + that interfaces with an implementation of the ```

docs/psa/index.md

					
				@ -0,0 +33,4 @@

				For more information, see [PSA secure element driver interface](se/).

				### Entropy source driver interface

- Github
+ GitHub

```diff - Github + GitHub ```

docs/psa/se/index.md

					
				@ -0,0 +1,14 @@

				# PSA secure element driver interface

- The accelerator interface lets you drivers
+ The secure element interface lets you write drivers

```diff - The accelerator interface lets you drivers + The secure element interface lets you write drivers ```

- into an implementation of the
+ that interfaces with an implementation of the

```diff - into an implementation of the + that interfaces with an implementation of the ```

gilles-peskine-arm (Migrated from github.com) reviewed

2019-10-15 10:50:59 -05:00

docs/psa/accel/index.md

					
				@ -0,0 +1,11 @@

				# PSA cryptographic accelerator interface

I think I started to write “lets you plug … into …” then fiddled with the sentence quite a bit and it's still not quite right. Suggestions welcome. Maybe split this into two sentences?

Patater (Migrated from github.com) reviewed

2019-10-15 11:36:45 -05:00

docs/psa/accel/index.md

					
				@ -0,0 +1,11 @@

				# PSA cryptographic accelerator interface

Yes, plug would make more sense. It wasn't the first word that came to mind when I read the first part of the sentence and tried to fill in the gap. Rewrite would be good.

Patater (Migrated from github.com) requested changes

2019-10-15 11:38:05 -05:00

docs/psa/index.md

Do you want another newline above here like in the other sections?

gilles-peskine-arm (Migrated from github.com) reviewed

2019-10-15 11:42:41 -05:00

docs/psa/index.md

I don't understand. A newline where? Are you talking about source formatting or rendering?

Patater (Migrated from github.com) reviewed

2019-10-16 03:30:27 -05:00

docs/psa/index.md

Source format.

Here, we have the following in source.

The secure element driver interface lets you write drivers for external cryptoprocessors such as secure elements (SE), smart cards and hardware security modules (HSM) that perform operations on keys that never leave the external processor and are accessed only through opaque handles.
You can plug such drivers into any implementation of the PSA Cryptography API.

In other similar places, we have:

However, I now see I was fooled by GitHub adding the vertical whitespace. There is no extra newline present.

Source format. Here, we have the following in source. ``` The secure element driver interface lets you write drivers for external cryptoprocessors such as secure elements (SE), smart cards and hardware security modules (HSM) that perform operations on keys that never leave the external processor and are accessed only through opaque handles. You can plug such drivers into any implementation of the PSA Cryptography API. ``` In other similar places, we have: ![Screenshot at 2019-10-16 09-29-23](https://user-images.githubusercontent.com/410816/66901891-7deaa100-eff7-11e9-9bae-69b5c3123952.png) However, I now see I was fooled by GitHub adding the vertical whitespace. There is no extra newline present.