From 9f3468dcfc92fca43ac105204427d03c863b4b4b Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 11 Aug 2013 08:17:48 -0400 Subject: Better describe why this library exists. Refs #5 --- docs/index.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 1d8ffda6..a061b3e7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,6 +8,19 @@ Welcome to ``cryptography`` ``cryptography`` is a Python library which exposes cryptographic primitives and recipes. +Why a new crypto library for Python? +------------------------------------ + +We wanted to address a few issues with existing cryptography libraries in +Python: + +* Lack of PyPy support +* Lack of maintenance +* Use poor implementations of algorithms (i.e. ones with known side-channel + attacks) +* Lack of high level, "Cryptography for humans", APIs + + Contents: .. toctree:: -- cgit v1.2.3 From 3538fdbc5c85485628ac220f1287537b01fb6b11 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 11 Aug 2013 08:18:40 -0400 Subject: Make this a heading --- docs/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index a061b3e7..99851577 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,7 +21,8 @@ Python: * Lack of high level, "Cryptography for humans", APIs -Contents: +Contents +-------- .. toctree:: :maxdepth: 2 -- cgit v1.2.3 From ec4ba7385752812d2acd113fc7f2e1529402c504 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 11 Aug 2013 08:19:05 -0400 Subject: Better gramar --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 99851577..c7f02da7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,7 +16,7 @@ Python: * Lack of PyPy support * Lack of maintenance -* Use poor implementations of algorithms (i.e. ones with known side-channel +* Use of poor implementations of algorithms (i.e. ones with known side-channel attacks) * Lack of high level, "Cryptography for humans", APIs -- cgit v1.2.3 From aa66554116d47ef725b5617b814034e0140560a8 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 11 Aug 2013 08:41:03 -0400 Subject: Document that we want AES-GCM --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index c7f02da7..f1a0cd84 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,7 @@ Python: * Use of poor implementations of algorithms (i.e. ones with known side-channel attacks) * Lack of high level, "Cryptography for humans", APIs +* Absence of algorithms such as AES-GCM Contents -- cgit v1.2.3 From 4373d7a2939454a976c0fcd08f756f793058d1d5 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 11 Aug 2013 08:57:17 -0400 Subject: Added another item from hynek --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index f1a0cd84..49e7b29e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,6 +20,7 @@ Python: attacks) * Lack of high level, "Cryptography for humans", APIs * Absence of algorithms such as AES-GCM +* Poor introspectability, and thus poor testability Contents -- cgit v1.2.3 From d6bef56f290dbc4354ab90d9cdffccb8704522bc Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 11 Aug 2013 09:09:28 -0400 Subject: English grammar --- docs/index.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 49e7b29e..12e74ed8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,13 +14,13 @@ Why a new crypto library for Python? We wanted to address a few issues with existing cryptography libraries in Python: -* Lack of PyPy support -* Lack of maintenance +* Lack of PyPy support. +* Lack of maintenance. * Use of poor implementations of algorithms (i.e. ones with known side-channel - attacks) -* Lack of high level, "Cryptography for humans", APIs -* Absence of algorithms such as AES-GCM -* Poor introspectability, and thus poor testability + attacks). +* Lack of high level, "Cryptography for humans", APIs. +* Absence of algorithms such as AES-GCM. +* Poor introspectability, and thus poor testability. Contents -- cgit v1.2.3 From f0d139aa2d9d194dcf7ace775053039e0724bb11 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Sun, 11 Aug 2013 09:13:27 -0400 Subject: Another issue we're targetting --- docs/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 12e74ed8..29f0b545 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,6 +21,7 @@ Python: * Lack of high level, "Cryptography for humans", APIs. * Absence of algorithms such as AES-GCM. * Poor introspectability, and thus poor testability. +* Extremely error prone APIs, and bad defaults. Contents -- cgit v1.2.3