Skip to content

Commit 7778c60

Browse files
spbsolublespbsoluble
committed
fix: Disable logging by default.
1 parent 36ddf81 commit 7778c60

File tree

8 files changed

+150
-85
lines changed

8 files changed

+150
-85
lines changed

‎v3/api/agent.go‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,14 @@ package api
1717
import (
1818
"encoding/json"
1919
"fmt"
20+
"log"
2021
"regexp"
2122
)
2223

2324
// GetAgentList returns a list of orchestrators registered in the Keyfactor instance
2425
func (c *Client) GetAgentList() ([]Agent, error) {
25-
// 0
26+
log.Println("[INFO] Getting a list of agents registered in Keyfactor")
27+
2628
// Set Keyfactor-specific headers
2729
headers := &apiHeaders{
2830
Headers: []StringTuple{
@@ -52,7 +54,8 @@ func (c *Client) GetAgentList() ([]Agent, error) {
5254
}
5355

5456
func (c *Client) GetAgent(id string) ([]Agent, error) {
55-
// 0
57+
log.Println("[INFO] Getting agent by ID or name.")
58+
5659
// Set Keyfactor-specific headers
5760
headers := &apiHeaders{
5861
Headers: []StringTuple{
@@ -103,7 +106,8 @@ func (c *Client) GetAgent(id string) ([]Agent, error) {
103106
}
104107

105108
func (c *Client) ApproveAgent(id string) (string, error) {
106-
// 0
109+
log.Printf("[INFO] Approving agent %s in Keyfactor.\n", id)
110+
107111
// Set Keyfactor-specific headers
108112
headers := &apiHeaders{
109113
Headers: []StringTuple{
@@ -137,7 +141,8 @@ func (c *Client) ApproveAgent(id string) (string, error) {
137141
}
138142

139143
func (c *Client) DisApproveAgent(id string) (string, error) {
140-
// 0
144+
log.Printf("[INFO] Disapproving agent %s in Keyfactor.\n", id)
145+
141146
// Set Keyfactor-specific headers
142147
headers := &apiHeaders{
143148
Headers: []StringTuple{
@@ -171,7 +176,8 @@ func (c *Client) DisApproveAgent(id string) (string, error) {
171176
}
172177

173178
func (c *Client) ResetAgent(id string) (string, error) {
174-
// 0
179+
log.Printf("[INFO] Resetting agent %s in Keyfactor.\n", id)
180+
175181
// Set Keyfactor-specific headers
176182
headers := &apiHeaders{
177183
Headers: []StringTuple{
@@ -204,7 +210,8 @@ func (c *Client) ResetAgent(id string) (string, error) {
204210
}
205211

206212
func (c *Client) FetchAgentLogs(id string) (string, error) {
207-
// 0
213+
log.Printf("[INFO] Fetching agent logs for %s.\n", id)
214+
208215
// Set Keyfactor-specific headers
209216
headers := &apiHeaders{
210217
Headers: []StringTuple{

‎v3/api/ca.go‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,13 @@ package api
1616

1717
import (
1818
"encoding/json"
19+
"log"
1920
)
2021

2122
// GetCAList returns a list of certificate authorities supported by the Keyfactor instance
2223
func (c *Client) GetCAList() ([]CA, error) {
23-
// 0
24+
log.Println("[INFO] Getting a list of CAs from Keyfactor instance")
25+
2426
// Set Keyfactor-specific headers
2527
headers := &apiHeaders{
2628
Headers: []StringTuple{

‎v3/api/certificate.go‎

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ import (
3434
// EnrollPFX takes arguments for EnrollPFXFctArgs to facilitate a call to Keyfactor
3535
// that enrolls a PFX certificate with the supplied arguments.
3636
func (c *Client) EnrollPFX(ea *EnrollPFXFctArgs) (*EnrollResponse, error) {
37-
// 0
37+
log.Println("[INFO] Enrolling PFX certificate with Keyfactor")
38+
3839
/* Ensure required inputs exist */
3940
var missingFields []string
4041

@@ -106,7 +107,8 @@ func (c *Client) EnrollPFX(ea *EnrollPFXFctArgs) (*EnrollResponse, error) {
106107
}
107108

108109
func (c *Client) EnrollPFXV2(ea *EnrollPFXFctArgsV2) (*EnrollResponseV2, error) {
109-
// 0
110+
log.Println("[INFO] Enrolling PFX certificate with Keyfactor")
111+
110112
/* Ensure required inputs exist */
111113
var missingFields []string
112114

@@ -160,7 +162,8 @@ func (c *Client) EnrollPFXV2(ea *EnrollPFXFctArgsV2) (*EnrollResponseV2, error)
160162
Payload: &ea,
161163
}
162164

163-
// 0
165+
log.Println("[TRACE] Request: ", keyfactorAPIStruct)
166+
164167
resp, err := c.sendRequest(keyfactorAPIStruct)
165168
if err != nil {
166169
return nil, err
@@ -194,7 +197,8 @@ func (c *Client) DownloadCertificate(
194197
serialNumber string,
195198
issuerDn string,
196199
) (*x509.Certificate, []*x509.Certificate, error) {
197-
// 0
200+
log.Println("[INFO] Downloading certificate")
201+
198202
/* The download certificate endpoint requires one of the following to retrieve a cert:
199203
- CertID
200204
- Thumbprint
@@ -282,7 +286,8 @@ func (c *Client) DownloadCertificate(
282286
// - Template : string
283287
// - CertificateAuthority : string
284288
func (c *Client) EnrollCSR(ea *EnrollCSRFctArgs) (*EnrollResponse, error) {
285-
// 0
289+
log.Println("[INFO] Signing CSR with Keyfactor")
290+
286291
/* Ensure required inputs exist */
287292
if (ea.Template == "") || (ea.CertificateAuthority == "") {
288293
return nil, errors.New("invalid or nonexistent values required for csr enrollment")
@@ -328,9 +333,9 @@ func (c *Client) EnrollCSR(ea *EnrollCSRFctArgs) (*EnrollResponse, error) {
328333
// - CertificateIds : []int
329334
// - Comment : string
330335
func (c *Client) RevokeCert(rvargs *RevokeCertArgs) error {
331-
// 0
336+
log.Println("[INFO] Revoking certificates")
332337
//for _, certs := range rvargs.CertificateIds {
333-
// // 0
338+
// log.Printf("[TRACE] Revoking ID %d", certs)
334339
//}
335340

336341
// Fields required by revoke cert API request are cert ID & comment
@@ -640,8 +645,8 @@ func (c *Client) RecoverCertificate(
640645
password string,
641646
collectionId int,
642647
) (interface{}, *x509.Certificate, []*x509.Certificate, error) {
643-
// 0
644-
// 0
648+
log.Println("[DEBUG] Enter RecoverCertificate")
649+
log.Println("[INFO] Recovering certificate ID:", certId)
645650
/* The download certificate endpoint requires one of the following to retrieve a cert:
646651
- CertID
647652
- Thumbprint
@@ -659,10 +664,11 @@ func (c *Client) RecoverCertificate(
659664
}
660665

661666
if !validInput {
662-
// 0
667+
log.Println("[ERROR] RecoverCertificate: certID, thumbprint, or serial number AND issuer DN required to download certificate")
663668
return nil, nil, nil, fmt.Errorf("certID, thumbprint, or serial number AND issuer DN required to download certificate")
664669
}
665-
// 0
670+
log.Println("[DEBUG] RecoverCertificate: Valid input")
671+
666672
if password == "" {
667673
return nil, nil, nil, fmt.Errorf("password required to recover private key with certificate")
668674
}
@@ -676,7 +682,7 @@ func (c *Client) RecoverCertificate(
676682
IncludeChain: true,
677683
}
678684

679-
// 0
685+
log.Println("[DEBUG] RecoverCertificate: Recovering certificate with args:", rca)
680686
// Set Keyfactor-specific headers
681687
headers := &apiHeaders{
682688
Headers: []StringTuple{
@@ -691,16 +697,16 @@ func (c *Client) RecoverCertificate(
691697
Query: []StringTuple{},
692698
}
693699
if collectionId > 0 {
694-
// 0
700+
log.Println("[DEBUG] RecoverCertificate: Collection ID:", collectionId)
695701
query.Query = append(
696702
query.Query, StringTuple{
697703
"collectionId", fmt.Sprintf("%d", collectionId),
698704
},
699705
)
700-
// 0
706+
log.Println("[DEBUG] RecoverCertificate: Query:", query)
701707
}
702708

703-
// 0
709+
log.Println("[DEBUG] RecoverCertificate: Creating recover certificate request")
704710
keyfactorAPIStruct := &request{
705711
Method: "POST",
706712
Endpoint: "Certificates/Recover",
@@ -709,37 +715,37 @@ func (c *Client) RecoverCertificate(
709715
Query: &query,
710716
}
711717

712-
// 0
718+
log.Println("[INFO] Attempting to recover certificate from Keyfactor Command")
713719
resp, err := c.sendRequest(keyfactorAPIStruct)
714720
if err != nil {
715721
log.Println("[ERROR] RecoverCertificate: Error recovering certificate from Keyfactor Command", err.Error())
716722
return nil, nil, nil, err
717723
}
718724

719725
jsonResp := &recoverCertResponse{}
720-
// 0
726+
log.Println("[DEBUG] RecoverCertificate: Decoding response")
721727
err = json.NewDecoder(resp.Body).Decode(&jsonResp)
722728
if err != nil {
723729
log.Println("[ERROR] RecoverCertificate: Error decoding response from Keyfactor Command", err.Error())
724730
return nil, nil, nil, err
725731
}
726732

727-
// 0
733+
log.Println("[DEBUG] RecoverCertificate: Decoding PFX")
728734
pfxDer, err := base64.StdEncoding.DecodeString(jsonResp.PFX)
729735
if err != nil {
730736
log.Println("[ERROR] RecoverCertificate: Error decoding PFX", err.Error())
731737
return nil, nil, nil, err
732738
}
733739

734-
// 0
740+
log.Println("[DEBUG] RecoverCertificate: Decoding PFX chain")
735741
priv, leaf, chain, err := pkcs12.DecodeChain(pfxDer, rca.Password)
736742
if err != nil {
737743
log.Println("[ERROR] RecoverCertificate: Error decoding PFX chain", err.Error())
738744
return nil, nil, nil, err
739745
}
740746

741-
// 0
742-
// 0
747+
log.Println("[INFO] Recovered certificate successfully")
748+
log.Println("[DEBUG] RecoverCertificate: ", leaf, chain)
743749
return priv, leaf, chain, nil
744750
}
745751

@@ -794,7 +800,7 @@ func validateDeployPFXArgs(dpfxa *DeployPFXArgs) error {
794800

795801
// decodePKCS12Blob decodes a PKCS12 blob.
796802
func decodePKCS12Blob(resp *EnrollResponse) error {
797-
// 0
803+
log.Println("[TRACE] Decoding certificate")
798804
// Keyfactor returns base-64 PFX (PKCS#12) or zipped certificate. Decode here.
799805
if resp.CertificateInformation.PKCS12Blob != "" {
800806
cert, err := base64.StdEncoding.DecodeString(resp.CertificateInformation.PKCS12Blob)

0 commit comments

Comments
 (0)