Skip to content

Commit 019d9fd

Browse files
committed
remove more outdated docs
1 parent 8fed1e3 commit 019d9fd

3 files changed

Lines changed: 6 additions & 12 deletions

File tree

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,6 @@ action!
4343
* Generic ASN.1 abstractions to operate on and create arbitrary ASN.1 Data
4444
* JOSE-related data structures (JSON Web Keys, JWT, etc…)
4545
* COSE-related data structures (COSE Keys, CWT, etc…)
46-
* Serializability of all ASN.1 classes for debugging **and only for debugging!!!** *Seriously, do not try to deserialize
47-
ASN.1 classes through kotlinx.serialization! Use `decodeFromDer()` and its companions!*
4846
* 100% pure Kotlin BitSet
4947
* Exposes Multibase Encoder/Decoder as an API dependency including [Matthew Nelson's smashing Base16, Base32, and Base64 encoders](https://github.com/05nelsonm/encoding)
5048
* **ASN.1 Parser and Encoder including a DSL to generate ASN.1 structures**
@@ -113,14 +111,14 @@ certificates, CSRs, as well as COSE and JOSE data. Hence, we needed a fully-feat
113111
X.509 to COSE and JOSE datatypes. We required comprehensive ASN.1 introspection and builder capabilities across platforms.
114112
Most notably, Apple has been notoriously lacking anything even remotely usable
115113
and [SwiftASN1](https://github.com/apple/swift-asn1) was out of the question for a couple of reasons.
116-
Most notably, it did not exist, when we started work on Signum. Hence, there was **neither ASN.1 parser, nor encoder on Apple platforms**
117-
that was actually usable. In effect: there way no KMP ASN.1 codec in sight, much less a type-safe, user-friendly one.
114+
Most notably, it did not exist when we started work on Signum. Hence, there was **neither ASN.1 parser, nor encoder on Apple platforms**
115+
that was actually usable. In effect: there was no KMP ASN.1 codec in sight, much less a type-safe, user-friendly one.
118116
As it stands now, our ASN.1 engine can handle almost anything you throw at it, in some areas even exceeding Bouncy Castle!
119117
cryptography-kotlin only added basic ASN.1 capabilities over a year after Signum's development started.
120118
<br>
121119
We are also unaware of any other library offering comprehensive JOSE and COSE data structures based on kotlinx-serialization.
122120
Hence, we implemented those ourselves, with first-class interop to our generic cryptographic data structures.
123-
We also support platform-native interop meaning that you can easily convert a Json Web Key to a JCA key or even a `SecKeyRef`.
121+
We also support platform-native interop meaning that you can easily convert a Json Web Key to a JCA key or even a `SecKeyRef` on iOS.
124122

125123
Having actual implementations of cryptographic operations available was only second on our list of priorities. From the
126124
get-go, it was clear that we wanted the tightest possible platform integration on Android and iOS, including hardware-backed

docs/docs/index.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ types and platform-native functionality related to crypto and PKI applications:
3232
* Generic ASN.1 abstractions to operate on and create arbitrary ASN.1 Data
3333
* JOSE-related data structures (JSON Web Keys, JWT, etc…)
3434
* COSE-related data structures (COSE Keys, CWT, etc…)
35-
* Serializability of all ASN.1 classes for debugging **and only for debugging!!!** *Seriously, do not try to deserialize
36-
ASN.1 classes through kotlinx.serialization! Use `decodeFromDer()` and its companions!*
3735
* 100% pure Kotlin BitSet
3836
* Exposes Multibase Encoder/Decoder as an API dependency
3937
including [Matthew Nelson's smashing Base16, Base32, and Base64 encoders](https://github.com/05nelsonm/encoding)
@@ -104,14 +102,14 @@ and comprehensive ASN.1, JOSE, and COSE support.
104102
X.509 to COSE and JOSE datatypes. We required comprehensive ASN.1 introspection and builder capabilities across platforms.
105103
Most notably, Apple has been notoriously lacking anything even remotely usable
106104
and [SwiftASN1](https://github.com/apple/swift-asn1) was out of the question for a couple of reasons.
107-
Most notably, it did not exist, when we started work on Signum. Hence, there was **neither ASN.1 parser, nor encoder on Apple platforms**
108-
that was actually usable. In effect: there way no KMP ASN.1 codec in sight, much less a type-safe, user-friendly one.
105+
Most notably, it did not exist when we started work on Signum. Hence, there was **neither ASN.1 parser, nor encoder on Apple platforms**
106+
that was actually usable. In effect: there was no KMP ASN.1 codec in sight, much less a type-safe, user-friendly one.
109107
As it stands now, our ASN.1 engine can handle almost anything you throw at it, in some areas even exceeding Bouncy Castle!
110108
cryptography-kotlin only added basic ASN.1 capabilities over a year after Signum's development started.
111109
<br>
112110
We are also unaware of any other library offering comprehensive JOSE and COSE data structures based on kotlinx-serialization.
113111
Hence, we implemented those ourselves, with first-class interop to our generic cryptographic data structures.
114-
We also support platform-native interop meaning that you can easily convert a Json Web Key to a JCA key or even a `SecKeyRef`.
112+
We also support platform-native interop meaning that you can easily convert a Json Web Key to a JCA key or even a `SecKeyRef` on iOS.
115113

116114
Having actual implementations of cryptographic operations available was only second on our list of priorities. From the
117115
get-go, it was clear that we wanted the tightest possible platform integration on Android and iOS, including hardware-backed

docs/docs/indispensable.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,8 +187,6 @@ The following section provides more details on the various patterns used for ASN
187187
As mentioned before, classes like `CryptoPublicKey`, `X509Certificate`, and `ObjectIdentifier` all implement `Asn1Encodable`
188188
while their companions implement `Asn1Decodable`.
189189
These interfaces essentially provide a mapping between custom types and low-level TLV structures that can directly be encoded, conforming to DER.
190-
This also means, a direct serialization of such custom types is valuable for debugging, but not for encoding.
191-
**Hence, decoding a kotlinx.serialization output of those classes is unsupported.**
192190

193191
In addition, `CryptoPublicKey`, `CryptoPrivateKey`, `X509Certificate`, `Pkcs10CertificationRequest` also implement `PemEncodable`,
194192
while their respective companions implement `PemDecodable`.

0 commit comments

Comments
 (0)