From e16b077d20eceee7ab54bde90105187010eceed4 Mon Sep 17 00:00:00 2001 From: Jacky Date: Tue, 30 Apr 2024 19:48:48 +0800 Subject: [PATCH] feat: using renewal api to renew certificate #319 --- api/certificate/issue.go | 9 +++++ app/src/language/zh_CN/app.mo | Bin 23633 -> 23638 bytes app/src/language/zh_CN/app.po | 6 ++-- internal/cert/auto_cert.go | 14 ++++++-- internal/cert/cert.go | 51 ++++----------------------- internal/cert/obtain.go | 63 ++++++++++++++++++++++++++++++++++ internal/cert/payload.go | 13 ++++--- internal/cert/renew.go | 36 +++++++++++++++++++ internal/cron/cron.go | 2 +- internal/kernal/boot.go | 2 +- model/cert.go | 48 +++++++++++++++++++------- 11 files changed, 173 insertions(+), 71 deletions(-) create mode 100644 internal/cert/obtain.go create mode 100644 internal/cert/renew.go diff --git a/api/certificate/issue.go b/api/certificate/issue.go index 2139ab2..d05f773 100644 --- a/api/certificate/issue.go +++ b/api/certificate/issue.go @@ -83,6 +83,14 @@ func IssueCert(c *gin.Context) { return } + certInfo, err := cert.GetCertInfo(certModel.SSLCertificatePath) + if err != nil { + logger.Error("get certificate info error", err) + return + } + payload.Resource = certModel.Resource + payload.NotBefore = certInfo.NotBefore + logChan := make(chan string, 1) errChan := make(chan error, 1) @@ -126,6 +134,7 @@ func IssueCert(c *gin.Context) { KeyType: payload.KeyType, ChallengeMethod: payload.ChallengeMethod, DnsCredentialID: payload.DNSCredentialID, + Resource: payload.Resource, }) if err != nil { diff --git a/app/src/language/zh_CN/app.mo b/app/src/language/zh_CN/app.mo index 1b8c8284a4e02f139cb137fe3cd6b5d9fb0d54e9..0dce6587e8983851897093e3d5eae05bad9e5d85 100644 GIT binary patch delta 2425 zcmXYzdx+F^6vaQ=x<0dPO*6}NG+)`8VkQdehC4emJ2URg>^ydMCNRQBL1r3JNc!^+ z4Kl6Nq%1M95OM`e!(7N$`KlCpp{0gmW+)U1p-B=kd(K~H&b{}0@45H;_|12Ft4{5$ z`uIfOpf9k$5o&-FjnE7Dz7a+O=Nh3qa9bD#1HHm91Q-#9+ku&3`BPyS4HUvK4p?UY z4*NTe2W>xQ{$rS+tH4id{i5wv5#=2of#E&c7L}oO@BS2fT1iaP^cLM8-TaCNy z|HAlHvl{%?{(qG>pif*0hQ>9T@o^o->2WD+jBAv$;+jBvT!rVwwf76+61Fa`Np(2x zWE}1T&cxv^;JUGALhA>2VF1Hy7?V(e@#fPKO4yiCfw{IXbKJ@VJW%P}_B{!WcAxQw zgeG|GfY5Pdn~X5|&oMpGkNQc%}t{%02$2MFp?6sL&1bnw0FdDG3>x(pHT!pKP4&xNu6H zWz6T;zsUHK?SXN1ilFNu+33XEQtD_=N@w6;N)tJ1Jnx17nAfBwur95_4;g2qB{*Y$ zF|E9F(`sO0T3Z#Qeg8Lj!6xGe#_egi4frGt)xf7txYvb_IPRx3OaRWC_sdAYJ;u6> z1dcSHVr&R9Ivf!jG8uJTG%m`(Bw$qrmIDVeFco;LRdGv<>sxi&ceKJZ;CL(C57cDU z`S7eJRi9Pd)U2*?kk2a7s}9)e1v|6qxHGFx_GQ(D4c0nD@DM-K)`&Sv)8s9O#U(gn8E5PE)$EKifM17kC z=h`3`1-#Ivr*xC?P#cti%WWFj%%TL%D(djfE9!7SBr24xK>o> zC)(xzxm{a!q22fYQo91KIp9C@nv$N_+L8)QF6n`al$0n}(&Wmv&ozJE{-q^NV1@bH zC71(jF2U14b-6)G7L@hYFDmPLtS_s;PV+rwm{|E|RMrS<9)~f&xZO7g9Rvq=HE8F^833hLc1rm4(a_rcH$+G delta 2419 zcmXYyTWpkd5XFB*tcY@xKtL>VFQ6a_YJj4F?yb8^cei`#cGpCSh!~-1NQhVXUaAR# z2!c^)ctAtc`a&(l1_`K$R>c_5V5A1qXcZHTiHZhE&}`3nI^UU@|IC^BU%sfw6ebUn-j`s$$?s0zW&z_1Y10MkQIS+_hSe`5%0fqV$&0h{c9 z$NnDUaoayJ|2jl4Sm2xu{l*I+mR?So3D!qoC9o|56M%COxC!{vygI7*Tchf9R#d`r##K=j zZjHhXK)dZbjQgT6q9QN~!-1Z_2~R{}F7UbWk^`p1r1-X&3avDjViNMGd238t@Qm$m z7(0z!j_Zj@;K`UK8T8pO;J_;}bv&d2#scGva~d>}WeuieaBXRBhy10bxjB8Szjyn~H zNx*k;7z11~UYF4NiGvux6dP(2Dlp%CX+jBCBvfFv?VB9eo`C6<&TT)O&}feu&m=U- z3kmJ@6|bvK%04y;;{sq-66OGPNfla?l#n1PrQ4F4%r5i&Nf-vamDGf~Y=7VQk=K7_ zJnOh0ld!1@eoI0d@OUE(-v93#Rq)qF75dwJXiD}mDG8aJ(pJqhzuQ>nxcZbjOPfDz zf1B|M+cz7xrU(WflGmL0KuR4QPU#FBPiZ12jpx1aAM>GU39L!0@Lc1vv;?Q^Z%!-k z>a-eYO>3(*r+xo-dqIcsb>rJ<7y=wj!!#~m<#Hz%P-b1)kCAP3_sKe3$l_(D#5el@2_kIXCY z#C%0q<^B(Tz`VR(yd~z1#&TZD*LvZGyb?ZT+>+N%XOHnnUK8!}`oD}-1x;dPK>{XK zuyX&W6;xo39SaLeu*5uDfT2LCppG6aNWez>pEGVV?lSHzXbbiiU;}WdpnpVdvjnG_ zA(#cUHR~yT)p)cS%0Pd!Mz*XdL9wC^->RYxS4UAodWsU(TU2M~jRQqE2V5+w^G{pk z|E5J-*4N_u|3ixcE;`_{IVC-@BT6cCXGss#@{$szN}623_J_<{?SHbQ2?XXZmtZxp zrv#4yS4;Ox$=b5s`gLVpkL_g@=rr#t!(G6aWsQ&rU^Xzj`||kS+pB*%)-iBocXx07 fgps@YGm%lD#_Z28?WkB^dH$EZ?cIx;YKH$0+X^Ky diff --git a/app/src/language/zh_CN/app.po b/app/src/language/zh_CN/app.po index 29dd43a..10b8bd4 100644 --- a/app/src/language/zh_CN/app.po +++ b/app/src/language/zh_CN/app.po @@ -442,7 +442,7 @@ msgstr "DNS 凭证" #: src/views/certificate/DNSChallenge.vue:74 #: src/views/domain/cert/components/DNSChallenge.vue:95 msgid "DNS Provider" -msgstr "DNS供应商" +msgstr "DNS 提供商" #: src/views/domain/cert/components/AutoCertStepOne.vue:104 msgid "DNS01" @@ -1181,8 +1181,8 @@ msgid "" "Please first add credentials in Certification > DNS Credentials, and then " "select one of the credentialsbelow to request the API of the DNS provider." msgstr "" -"请首先在 “证书”> “DNS凭证” 中添加凭证,然后在下方选择一个凭证,请求DNS提供商" -"的API。" +"请首先在 “证书”> “DNS 凭证” 中添加凭证,然后在下方选择一个凭证,请求 DNS 提供" +"商的 API。" #: src/views/domain/components/SiteDuplicate.vue:40 #: src/views/stream/components/StreamDuplicate.vue:40 diff --git a/internal/cert/auto_cert.go b/internal/cert/auto_cert.go index c2d351e..56c8141 100644 --- a/internal/cert/auto_cert.go +++ b/internal/cert/auto_cert.go @@ -11,7 +11,7 @@ import ( "time" ) -func AutoObtain() { +func AutoCert() { defer func() { if err := recover(); err != nil { buf := make([]byte, 1024) @@ -22,12 +22,12 @@ func AutoObtain() { logger.Info("AutoCert Worker Started") autoCertList := model.GetAutoCertList() for _, certModel := range autoCertList { - renew(certModel) + autoCert(certModel) } logger.Info("AutoCert Worker End") } -func renew(certModel *model.Cert) { +func autoCert(certModel *model.Cert) { confName := certModel.Filename log := &Logger{} @@ -75,6 +75,14 @@ func renew(certModel *model.Cert) { ChallengeMethod: certModel.ChallengeMethod, DNSCredentialID: certModel.DnsCredentialID, KeyType: certModel.GetKeyType(), + Resource: &model.CertificateResource{ + Resource: certModel.Resource.Resource, + PrivateKey: certModel.Resource.PrivateKey, + Certificate: certModel.Resource.Certificate, + IssuerCertificate: certModel.Resource.IssuerCertificate, + CSR: certModel.Resource.CSR, + }, + NotBefore: cert.NotBefore, } // errChan will be closed inside IssueCert diff --git a/internal/cert/cert.go b/internal/cert/cert.go index f8b80ad..72117e7 100644 --- a/internal/cert/cert.go +++ b/internal/cert/cert.go @@ -7,7 +7,6 @@ import ( "github.com/0xJacky/Nginx-UI/internal/nginx" "github.com/0xJacky/Nginx-UI/query" "github.com/0xJacky/Nginx-UI/settings" - "github.com/go-acme/lego/v4/certificate" "github.com/go-acme/lego/v4/challenge/http01" "github.com/go-acme/lego/v4/lego" legolog "github.com/go-acme/lego/v4/log" @@ -16,8 +15,6 @@ import ( "log" "net/http" "os" - "path/filepath" - "strings" "time" ) @@ -44,15 +41,13 @@ func IssueCert(payload *ConfigPayload, logChan chan string, errChan chan error) // Hijack the (logger) of lego legolog.Logger = l - domain := payload.ServerName - l.Println("[INFO] [Nginx UI] Preparing lego configurations") user, err := payload.GetACMEUser() if err != nil { errChan <- errors.Wrap(err, "issue cert get acme user error") return } - l.Printf("[INFO] [Nginx UI] ACME User: %s, CA Dir: %s\n", user.Email, user.CADir) + l.Printf("[INFO] [Nginx UI] ACME User: %s, Email: %s, CA Dir: %s\n", user.Name, user.Email, user.CADir) // Start a goroutine to fetch and process logs from channel go func() { @@ -134,45 +129,11 @@ func IssueCert(payload *ConfigPayload, logChan chan string, errChan chan error) return } - request := certificate.ObtainRequest{ - Domains: domain, - Bundle: true, - } - - l.Println("[INFO] [Nginx UI] Obtaining certificate") - certificates, err := client.Certificate.Obtain(request) - if err != nil { - errChan <- errors.Wrap(err, "obtain certificate error") - return - } - name := strings.Join(domain, "_") - saveDir := nginx.GetConfPath("ssl/" + name + "_" + string(payload.KeyType)) - if _, err = os.Stat(saveDir); os.IsNotExist(err) { - err = os.MkdirAll(saveDir, 0755) - if err != nil { - errChan <- errors.Wrap(err, "mkdir error") - return - } - } - - // Each certificate comes back with the cert bytes, the bytes of the client's - // private key, and a certificate URL. SAVE THESE TO DISK. - l.Println("[INFO] [Nginx UI] Writing certificate to disk") - err = os.WriteFile(filepath.Join(saveDir, "fullchain.cer"), - certificates.Certificate, 0644) - - if err != nil { - errChan <- errors.Wrap(err, "write fullchain.cer error") - return - } - - l.Println("[INFO] [Nginx UI] Writing certificate private key to disk") - err = os.WriteFile(filepath.Join(saveDir, "private.key"), - certificates.PrivateKey, 0644) - - if err != nil { - errChan <- errors.Wrap(err, "write private.key error") - return + if time.Now().Sub(payload.NotBefore).Hours()/24 <= 21 && + payload.Resource != nil && payload.Resource.Certificate != nil { + renew(payload, client, l, errChan) + } else { + obtain(payload, client, l, errChan) } l.Println("[INFO] [Nginx UI] Reloading nginx") diff --git a/internal/cert/obtain.go b/internal/cert/obtain.go new file mode 100644 index 0000000..e7a42f3 --- /dev/null +++ b/internal/cert/obtain.go @@ -0,0 +1,63 @@ +package cert + +import ( + "github.com/0xJacky/Nginx-UI/internal/nginx" + "github.com/0xJacky/Nginx-UI/model" + "github.com/go-acme/lego/v4/certificate" + "github.com/go-acme/lego/v4/lego" + "github.com/pkg/errors" + "log" + "os" + "path/filepath" + "strings" +) + +func obtain(payload *ConfigPayload, client *lego.Client, l *log.Logger, errChan chan error) { + request := certificate.ObtainRequest{ + Domains: payload.ServerName, + Bundle: true, + } + + l.Println("[INFO] [Nginx UI] Obtaining certificate") + certificates, err := client.Certificate.Obtain(request) + if err != nil { + errChan <- errors.Wrap(err, "obtain certificate error") + return + } + payload.Resource = &model.CertificateResource{ + Resource: certificates, + PrivateKey: certificates.PrivateKey, + Certificate: certificates.Certificate, + IssuerCertificate: certificates.IssuerCertificate, + CSR: certificates.CSR, + } + name := strings.Join(payload.ServerName, "_") + saveDir := nginx.GetConfPath("ssl/" + name + "_" + string(payload.KeyType)) + if _, err = os.Stat(saveDir); os.IsNotExist(err) { + err = os.MkdirAll(saveDir, 0755) + if err != nil { + errChan <- errors.Wrap(err, "mkdir error") + return + } + } + + // Each certificate comes back with the cert bytes, the bytes of the client's + // private key, and a certificate URL. SAVE THESE TO DISK. + l.Println("[INFO] [Nginx UI] Writing certificate to disk") + err = os.WriteFile(filepath.Join(saveDir, "fullchain.cer"), + certificates.Certificate, 0644) + + if err != nil { + errChan <- errors.Wrap(err, "write fullchain.cer error") + return + } + + l.Println("[INFO] [Nginx UI] Writing certificate private key to disk") + err = os.WriteFile(filepath.Join(saveDir, "private.key"), + certificates.PrivateKey, 0644) + + if err != nil { + errChan <- errors.Wrap(err, "write private.key error") + return + } +} diff --git a/internal/cert/payload.go b/internal/cert/payload.go index 730d4c4..310ab7d 100644 --- a/internal/cert/payload.go +++ b/internal/cert/payload.go @@ -6,14 +6,17 @@ import ( "github.com/0xJacky/Nginx-UI/model" "github.com/0xJacky/Nginx-UI/query" "github.com/go-acme/lego/v4/certcrypto" + "time" ) type ConfigPayload struct { - ServerName []string `json:"server_name"` - ChallengeMethod string `json:"challenge_method"` - DNSCredentialID int `json:"dns_credential_id"` - ACMEUserID int `json:"acme_user_id"` - KeyType certcrypto.KeyType `json:"key_type"` + ServerName []string `json:"server_name"` + ChallengeMethod string `json:"challenge_method"` + DNSCredentialID int `json:"dns_credential_id"` + ACMEUserID int `json:"acme_user_id"` + KeyType certcrypto.KeyType `json:"key_type"` + Resource *model.CertificateResource `json:"resource,omitempty"` + NotBefore time.Time } func (c *ConfigPayload) GetACMEUser() (user *model.AcmeUser, err error) { diff --git a/internal/cert/renew.go b/internal/cert/renew.go new file mode 100644 index 0000000..963e496 --- /dev/null +++ b/internal/cert/renew.go @@ -0,0 +1,36 @@ +package cert + +import ( + "github.com/0xJacky/Nginx-UI/model" + "github.com/go-acme/lego/v4/certificate" + "github.com/go-acme/lego/v4/lego" + "github.com/pkg/errors" + "log" +) + +func renew(payload *ConfigPayload, client *lego.Client, l *log.Logger, errChan chan error) { + if payload.Resource == nil { + errChan <- errors.New("resource is nil") + return + } + + options := &certificate.RenewOptions{ + Bundle: true, + } + + cert, err := client.Certificate.RenewWithOptions(payload.Resource.GetResource(), options) + if err != nil { + errChan <- errors.Wrap(err, "renew cert error") + return + } + + payload.Resource = &model.CertificateResource{ + Resource: cert, + PrivateKey: cert.PrivateKey, + Certificate: cert.Certificate, + IssuerCertificate: cert.IssuerCertificate, + CSR: cert.CSR, + } + + l.Println("[INFO] [Nginx UI] Certificate renewed successfully") +} diff --git a/internal/cron/cron.go b/internal/cron/cron.go index 450c7c5..a6b1e12 100644 --- a/internal/cron/cron.go +++ b/internal/cron/cron.go @@ -18,7 +18,7 @@ func init() { var logrotateJob *gocron.Job func InitCronJobs() { - job, err := s.Every(30).Minute().SingletonMode().Do(cert.AutoObtain) + job, err := s.Every(30).Minute().SingletonMode().Do(cert.AutoCert) if err != nil { logger.Fatalf("AutoCert Job: %v, Err: %v\n", job, err) diff --git a/internal/kernal/boot.go b/internal/kernal/boot.go index 1325931..dba91d0 100644 --- a/internal/kernal/boot.go +++ b/internal/kernal/boot.go @@ -90,7 +90,7 @@ func InitJsExtensionType() { func InitCronJobs() { s := gocron.NewScheduler(time.UTC) - job, err := s.Every(30).Minute().SingletonMode().Do(cert.AutoObtain) + job, err := s.Every(30).Minute().SingletonMode().Do(cert.AutoCert) if err != nil { logger.Fatalf("AutoCert Job: %v, Err: %v\n", job, err) diff --git a/model/cert.go b/model/cert.go index 442fff8..3088462 100644 --- a/model/cert.go +++ b/model/cert.go @@ -4,6 +4,7 @@ import ( "github.com/0xJacky/Nginx-UI/internal/helper" "github.com/0xJacky/Nginx-UI/internal/nginx" "github.com/go-acme/lego/v4/certcrypto" + "github.com/go-acme/lego/v4/certificate" "github.com/lib/pq" "os" ) @@ -17,21 +18,30 @@ const ( type CertDomains []string +type CertificateResource struct { + *certificate.Resource + PrivateKey []byte `json:"private_key"` + Certificate []byte `json:"certificate"` + IssuerCertificate []byte `json:"issuerCertificate"` + CSR []byte `json:"csr"` +} + type Cert struct { Model - Name string `json:"name"` - Domains pq.StringArray `json:"domains" gorm:"type:text[]"` - Filename string `json:"filename"` - SSLCertificatePath string `json:"ssl_certificate_path"` - SSLCertificateKeyPath string `json:"ssl_certificate_key_path"` - AutoCert int `json:"auto_cert"` - ChallengeMethod string `json:"challenge_method"` - DnsCredentialID int `json:"dns_credential_id"` - DnsCredential *DnsCredential `json:"dns_credential,omitempty"` - ACMEUserID int `json:"acme_user_id"` - ACMEUser *AcmeUser `json:"acme_user,omitempty"` - KeyType certcrypto.KeyType `json:"key_type"` - Log string `json:"log"` + Name string `json:"name"` + Domains pq.StringArray `json:"domains" gorm:"type:text[]"` + Filename string `json:"filename"` + SSLCertificatePath string `json:"ssl_certificate_path"` + SSLCertificateKeyPath string `json:"ssl_certificate_key_path"` + AutoCert int `json:"auto_cert"` + ChallengeMethod string `json:"challenge_method"` + DnsCredentialID int `json:"dns_credential_id"` + DnsCredential *DnsCredential `json:"dns_credential,omitempty"` + ACMEUserID int `json:"acme_user_id"` + ACMEUser *AcmeUser `json:"acme_user,omitempty"` + KeyType certcrypto.KeyType `json:"key_type"` + Log string `json:"log"` + Resource *CertificateResource `json:"-" gorm:"serializer:json"` } func FirstCert(confName string) (c Cert, err error) { @@ -99,3 +109,15 @@ func (c *Cert) Remove() error { func (c *Cert) GetKeyType() certcrypto.KeyType { return helper.GetKeyType(c.KeyType) } + +func (c *CertificateResource) GetResource() certificate.Resource { + return certificate.Resource{ + Domain: c.Resource.Domain, + CertURL: c.Resource.CertURL, + CertStableURL: c.Resource.CertStableURL, + PrivateKey: c.PrivateKey, + Certificate: c.Certificate, + IssuerCertificate: c.IssuerCertificate, + CSR: c.CSR, + } +}