weiguoqiang/cert-manager
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

update API comments

Browse Source 
Signed-off-by: Tim Ramlot <42113979+inteon@users.noreply.github.com>
This commit is contained in:
Tim Ramlot 2023-12-20 11:26:52 +01:00
parent ebf58b9967
commit 24794feac0
No known key found for this signature in database
GPG Key ID: 47428728E0C2878D
6 changed files with 21 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
deploy/crds/crd-certificates.yaml
View File

@ -154,7 +154,7 @@ spec:
- passwordSecretRef
properties:
algorithms:
description: "Algorithms are specifying the key and certificate encryption algorithms and the HMAC algorithm used to create the PKCS12 keystore. Default value is `LegacyRC2` for backward compatibility. \n If provided, allowed values are: `LegacyRC2`: Deprecated. Not supported by default in OpenSSL 3 or Java 20. `LegacyDES`: Less secure, used for maximal compatibility. `Modern2023`: Preferred for security, used when indicated by policy. PEM format also stored in Secret."
description: "Algorithms are specifying the key and certificate encryption algorithms and the HMAC algorithm used to create the PKCS12 keystore. Default value is `LegacyRC2` for backward compatibility. \n If provided, allowed values are: `LegacyRC2`: Deprecated. Not supported by default in OpenSSL 3 or Java 20. `LegacyDES`: Less secure algorithm. Use this option for maximal compatibility. `Modern2023`: Secure algorithm. Use this option in case you have to always use secure algorithms (eg. because of company policy). Please note that the security of the algorithm is not that important in reality, because the unencrypted certificate and private key are also stored in the Secret."
type: string
enum:
- LegacyRC2

6
internal/apis/certmanager/types_certificate.go
View File

@ -416,8 +416,10 @@ type PKCS12Keystore struct {
//
// If provided, allowed values are:
// `LegacyRC2`: Deprecated. Not supported by default in OpenSSL 3 or Java 20.
// `LegacyDES`: Less secure, used for maximal compatibility.
// `Modern2023`: Preferred for security, used when indicated by policy. PEM format also stored in Secret.
// `LegacyDES`: Less secure algorithm. Use this option for maximal compatibility.
// `Modern2023`: Secure algorithm. Use this option in case you have to always use secure algorithms
// (eg. because of company policy). Please note that the security of the algorithm is not that important
// in reality, because the unencrypted certificate and private key are also stored in the Secret.
Algorithms PKCS12Algorithms
}

6
internal/apis/certmanager/v1alpha2/types_certificate.go
View File

@ -338,8 +338,10 @@ type PKCS12Keystore struct {
//
// If provided, allowed values are:
// `LegacyRC2`: Deprecated. Not supported by default in OpenSSL 3 or Java 20.
// `LegacyDES`: Less secure, used for maximal compatibility.
// `Modern2023`: Preferred for security, used when indicated by policy. PEM format also stored in Secret.
// `LegacyDES`: Less secure algorithm. Use this option for maximal compatibility.
// `Modern2023`: Secure algorithm. Use this option in case you have to always use secure algorithms
// (eg. because of company policy). Please note that the security of the algorithm is not that important
// in reality, because the unencrypted certificate and private key are also stored in the Secret.
// +optional
Algorithms PKCS12Algorithms `json:"algorithms,omitempty"`
}

6
internal/apis/certmanager/v1alpha3/types_certificate.go
View File

@ -346,8 +346,10 @@ type PKCS12Keystore struct {
//
// If provided, allowed values are:
// `LegacyRC2`: Deprecated. Not supported by default in OpenSSL 3 or Java 20.
// `LegacyDES`: Less secure, used for maximal compatibility.
// `Modern2023`: Preferred for security, used when indicated by policy. PEM format also stored in Secret.
// `LegacyDES`: Less secure algorithm. Use this option for maximal compatibility.
// `Modern2023`: Secure algorithm. Use this option in case you have to always use secure algorithms
// (eg. because of company policy). Please note that the security of the algorithm is not that important
// in reality, because the unencrypted certificate and private key are also stored in the Secret.
// +optional
Algorithms PKCS12Algorithms `json:"algorithms,omitempty"`
}

6
internal/apis/certmanager/v1beta1/types_certificate.go
View File

@ -343,8 +343,10 @@ type PKCS12Keystore struct {
//
// If provided, allowed values are:
// `LegacyRC2`: Deprecated. Not supported by default in OpenSSL 3 or Java 20.
// `LegacyDES`: Less secure, used for maximal compatibility.
// `Modern2023`: Preferred for security, used when indicated by policy. PEM format also stored in Secret.
// `LegacyDES`: Less secure algorithm. Use this option for maximal compatibility.
// `Modern2023`: Secure algorithm. Use this option in case you have to always use secure algorithms
// (eg. because of company policy). Please note that the security of the algorithm is not that important
// in reality, because the unencrypted certificate and private key are also stored in the Secret.
// +optional
Algorithms PKCS12Algorithms `json:"algorithms,omitempty"`
}

6
pkg/apis/certmanager/v1/types_certificate.go
View File

@ -467,8 +467,10 @@ type PKCS12Keystore struct {
//
// If provided, allowed values are:
// `LegacyRC2`: Deprecated. Not supported by default in OpenSSL 3 or Java 20.
// `LegacyDES`: Less secure, used for maximal compatibility.
// `Modern2023`: Preferred for security, used when indicated by policy. PEM format also stored in Secret.
// `LegacyDES`: Less secure algorithm. Use this option for maximal compatibility.
// `Modern2023`: Secure algorithm. Use this option in case you have to always use secure algorithms
// (eg. because of company policy). Please note that the security of the algorithm is not that important
// in reality, because the unencrypted certificate and private key are also stored in the Secret.
// +optional
Algorithms PKCS12Algorithms `json:"algorithms,omitempty"`
}