Update release notes and API for 1.3.0

natemcmaster · Jun 25, 2023 · 4dfcf03 · 4dfcf03
1 parent ba8fa99
commit 4dfcf03
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 15 deletions.
diff --git a/src/LettuceEncrypt/PublicAPI.Shipped.txt b/src/LettuceEncrypt/PublicAPI.Shipped.txt
@@ -14,6 +14,11 @@ LettuceEncrypt.Acme.ChallengeType
 LettuceEncrypt.Acme.ChallengeType.Any = 65535 -> LettuceEncrypt.Acme.ChallengeType
 LettuceEncrypt.Acme.ChallengeType.Http01 = 1 -> LettuceEncrypt.Acme.ChallengeType
 LettuceEncrypt.Acme.ChallengeType.TlsAlpn01 = 2 -> LettuceEncrypt.Acme.ChallengeType
+LettuceEncrypt.Acme.ChallengeType.Dns01 = 4 -> LettuceEncrypt.Acme.ChallengeType
+LettuceEncrypt.Acme.DnsTxtRecordContext
+LettuceEncrypt.Acme.DnsTxtRecordContext.DnsTxtRecordContext(string! domainName, string! txt) -> void
+LettuceEncrypt.Acme.DnsTxtRecordContext.DomainName.get -> string!
+LettuceEncrypt.Acme.DnsTxtRecordContext.Txt.get -> string!
 LettuceEncrypt.Acme.EabCredentials
 LettuceEncrypt.Acme.EabCredentials.EabCredentials() -> void
 LettuceEncrypt.Acme.EabCredentials.EabKey.get -> string?
@@ -24,6 +29,10 @@ LettuceEncrypt.Acme.EabCredentials.EabKeyId.get -> string?
 LettuceEncrypt.Acme.EabCredentials.EabKeyId.set -> void
 LettuceEncrypt.Acme.ICertificateAuthorityConfiguration
 LettuceEncrypt.Acme.ICertificateAuthorityConfiguration.AcmeDirectoryUri.get -> System.Uri!
+LettuceEncrypt.Acme.ICertificateAuthorityConfiguration.IssuerCertificates.get -> string![]!
+LettuceEncrypt.Acme.IDnsChallengeProvider
+LettuceEncrypt.Acme.IDnsChallengeProvider.AddTxtRecordAsync(string! domainName, string! txt, System.Threading.CancellationToken ct = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<LettuceEncrypt.Acme.DnsTxtRecordContext!>!
+LettuceEncrypt.Acme.IDnsChallengeProvider.RemoveTxtRecordAsync(LettuceEncrypt.Acme.DnsTxtRecordContext! context, System.Threading.CancellationToken ct = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
 LettuceEncrypt.FileSystemStorageExtensions
 LettuceEncrypt.ICertificateRepository
 LettuceEncrypt.ICertificateRepository.SaveAsync(System.Security.Cryptography.X509Certificates.X509Certificate2! certificate, System.Threading.CancellationToken cancellationToken) -> System.Threading.Tasks.Task!
@@ -39,6 +48,8 @@ LettuceEncrypt.KeyAlgorithm.ES512 = 3 -> LettuceEncrypt.KeyAlgorithm
 LettuceEncrypt.LettuceEncryptOptions
 LettuceEncrypt.LettuceEncryptOptions.AcceptTermsOfService.get -> bool
 LettuceEncrypt.LettuceEncryptOptions.AcceptTermsOfService.set -> void
+LettuceEncrypt.LettuceEncryptOptions.AdditionalIssuers.get -> string![]!
+LettuceEncrypt.LettuceEncryptOptions.AdditionalIssuers.set -> void
 LettuceEncrypt.LettuceEncryptOptions.AllowedChallengeTypes.get -> LettuceEncrypt.Acme.ChallengeType
 LettuceEncrypt.LettuceEncryptOptions.AllowedChallengeTypes.set -> void
 LettuceEncrypt.LettuceEncryptOptions.DomainNames.get -> string![]!

diff --git a/src/LettuceEncrypt/PublicAPI.Unshipped.txt b/src/LettuceEncrypt/PublicAPI.Unshipped.txt
@@ -1,12 +1 @@
 #nullable enable
-LettuceEncrypt.Acme.ChallengeType.Dns01 = 4 -> LettuceEncrypt.Acme.ChallengeType
-LettuceEncrypt.Acme.ICertificateAuthorityConfiguration.IssuerCertificates.get -> string![]!
-LettuceEncrypt.Acme.IDnsChallengeProvider
-LettuceEncrypt.Acme.IDnsChallengeProvider.AddTxtRecordAsync(string! domainName, string! txt, System.Threading.CancellationToken ct = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<LettuceEncrypt.Acme.DnsTxtRecordContext!>!
-LettuceEncrypt.Acme.IDnsChallengeProvider.RemoveTxtRecordAsync(LettuceEncrypt.Acme.DnsTxtRecordContext! context, System.Threading.CancellationToken ct = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task!
-LettuceEncrypt.Acme.DnsTxtRecordContext
-LettuceEncrypt.Acme.DnsTxtRecordContext.DnsTxtRecordContext(string! domainName, string! txt) -> void
-LettuceEncrypt.Acme.DnsTxtRecordContext.DomainName.get -> string!
-LettuceEncrypt.Acme.DnsTxtRecordContext.Txt.get -> string!
-LettuceEncrypt.LettuceEncryptOptions.AdditionalIssuers.get -> string![]!
-LettuceEncrypt.LettuceEncryptOptions.AdditionalIssuers.set -> void
diff --git a/src/LettuceEncrypt/releasenotes.props b/src/LettuceEncrypt/releasenotes.props
@@ -2,11 +2,14 @@
   <PropertyGroup>
     <PackageReleaseNotes Condition="$(VersionPrefix.StartsWith('1.3.'))">
 New features:
-  * Add support for wildcard domains if you implement the IDnsChallengeProvider interface
+
+  * Add support for wildcard domains by using DNS challenges to validate domain ownership
+    * See https://github.com/natemcmaster/LettuceEncrypt#when-using-dns-01 for details.
+
   * Add option (#279) and API (#281) to configure additional valid issuers
-  * This is done by configuring certificates as strings. These are passed to certes internally when verifying the issuer
-  * Those certificates must be parseable by https://github.com/bcgit/bc-csharp/blob/830d9b8c7bdfcec511bff0a6cf4a0e8ed568e7c1/crypto/src/x509/X509CertificateParser.cs#L20
-  * For details, see https://github.com/fszlin/certes/blob/ffa00c6061b49de17901df0cd997cc7531e1607e/src/Certes/Pkcs/PfxBuilder.cs#L66
+    * This is done by configuring certificates as strings. These are passed to certes internally when verifying the issuer. 
+      Those certificates must be parseable by https://github.com/bcgit/bc-csharp/blob/830d9b8c7bdfcec511bff0a6cf4a0e8ed568e7c1/crypto/src/x509/X509CertificateParser.cs#L20
+      For details, see https://github.com/fszlin/certes/blob/ffa00c6061b49de17901df0cd997cc7531e1607e/src/Certes/Pkcs/PfxBuilder.cs#L66
 
 Other: