Inspect: Add error if no results (#19476)

When no results match or another error occurs, add an error to the stream. Keep the "inspect-input.txt" as the only thing in the zip for reference.

Example:

```
λ mc support inspect --airgap myminio/testbucket/fjghfjh/**
mc: Using public key from C:\Users\klaus\mc\support_public.pem
File data successfully downloaded as inspect-data.enc

λ inspect inspect-data.enc
Using private key from support_private.pem
output written to inspect-data.zip
2024/04/11 14:10:51 next stream: GetRawData: No files matched the given pattern

λ unzip -l inspect-data.zip
Archive:  inspect-data.zip
  Length      Date    Time    Name
---------  ---------- -----   ----
      222  2024-04-11 14:10   inspect-input.txt
---------                     -------
      222                     1 file

λ
```

Modifies inspect to read until end of stream to report the error.

Bonus: Add legacy commandline params
This commit is contained in:
Klaus Post 2024-04-11 14:22:47 -07:00 committed by GitHub
parent 41ec038523
commit 5206c0e883
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 57 additions and 21 deletions

View File

@ -3196,6 +3196,7 @@ func (a adminAPIHandlers) InspectDataHandler(w http.ResponseWriter, r *http.Requ
return return
} }
} }
addErr := func(msg string) {}
// Write a version for making *incompatible* changes. // Write a version for making *incompatible* changes.
// The AdminClient will reject any version it does not know. // The AdminClient will reject any version it does not know.
@ -3235,6 +3236,11 @@ func (a adminAPIHandlers) InspectDataHandler(w http.ResponseWriter, r *http.Requ
bugLogIf(ctx, stream.AddError(err.Error())) bugLogIf(ctx, stream.AddError(err.Error()))
return return
} }
addErr = func(msg string) {
inspectZipW.Close()
encStream.Close()
stream.AddError(msg)
}
defer encStream.Close() defer encStream.Close()
inspectZipW = zip.NewWriter(encStream) inspectZipW = zip.NewWriter(encStream)
@ -3315,18 +3321,6 @@ func (a adminAPIHandlers) InspectDataHandler(w http.ResponseWriter, r *http.Requ
} }
return nil return nil
} }
err := o.GetRawData(ctx, volume, file, rawDataFn)
if !errors.Is(err, errFileNotFound) {
adminLogIf(ctx, err)
}
// save the format.json as part of inspect by default
if !(volume == minioMetaBucket && file == formatConfigFile) {
err = o.GetRawData(ctx, minioMetaBucket, formatConfigFile, rawDataFn)
}
if !errors.Is(err, errFileNotFound) {
adminLogIf(ctx, err)
}
// save args passed to inspect command // save args passed to inspect command
var sb bytes.Buffer var sb bytes.Buffer
@ -3339,6 +3333,24 @@ func (a adminAPIHandlers) InspectDataHandler(w http.ResponseWriter, r *http.Requ
sb.WriteString("\n") sb.WriteString("\n")
adminLogIf(ctx, embedFileInZip(inspectZipW, "inspect-input.txt", sb.Bytes(), 0o600)) adminLogIf(ctx, embedFileInZip(inspectZipW, "inspect-input.txt", sb.Bytes(), 0o600))
err := o.GetRawData(ctx, volume, file, rawDataFn)
if err != nil {
if errors.Is(err, errFileNotFound) {
addErr("GetRawData: No files matched the given pattern")
return
}
embedFileInZip(inspectZipW, "GetRawData-err.txt", []byte(err.Error()), 0o600)
adminLogIf(ctx, err)
}
// save the format.json as part of inspect by default
if !(volume == minioMetaBucket && file == formatConfigFile) {
err = o.GetRawData(ctx, minioMetaBucket, formatConfigFile, rawDataFn)
}
if !errors.Is(err, errFileNotFound) {
adminLogIf(ctx, err)
}
scheme := "https" scheme := "https"
if !globalIsTLS { if !globalIsTLS {
scheme = "http" scheme = "http"

View File

@ -477,7 +477,7 @@ func mergeDisksLayoutFromArgs(args []string, ctxt *serverCtxt) (err error) {
} }
ctxt.Layout = disksLayout{ ctxt.Layout = disksLayout{
legacy: true, legacy: true,
pools: []poolDisksLayout{{layout: setArgs}}, pools: []poolDisksLayout{{layout: setArgs, cmdline: strings.Join(args, " ")}},
} }
return return
} }

View File

@ -27,7 +27,7 @@ import (
"github.com/secure-io/sio-go" "github.com/secure-io/sio-go"
) )
func extractInspectV1(keyHex string, r io.Reader, w io.Writer) error { func extractInspectV1(keyHex string, r io.Reader, w io.Writer, okMsg string) error {
id, err := hex.DecodeString(keyHex[:8]) id, err := hex.DecodeString(keyHex[:8])
if err != nil { if err != nil {
return err return err
@ -51,5 +51,8 @@ func extractInspectV1(keyHex string, r io.Reader, w io.Writer) error {
nonce := make([]byte, stream.NonceSize()) nonce := make([]byte, stream.NonceSize())
encr := stream.DecryptReader(r, nonce, nil) encr := stream.DecryptReader(r, nonce, nil)
_, err = io.Copy(w, encr) _, err = io.Copy(w, encr)
if err == nil {
fmt.Println(okMsg)
}
return err return err
} }

View File

@ -26,7 +26,11 @@ import (
"github.com/minio/madmin-go/v3/estream" "github.com/minio/madmin-go/v3/estream"
) )
func extractInspectV2(pk []byte, r io.Reader, w io.Writer) error { type keepFileErr struct {
error
}
func extractInspectV2(pk []byte, r io.Reader, w io.Writer, okMsg string) error {
privKey, err := bytesToPrivateKey(pk) privKey, err := bytesToPrivateKey(pk)
if err != nil { if err != nil {
return fmt.Errorf("decoding key returned: %w", err) return fmt.Errorf("decoding key returned: %w", err)
@ -45,11 +49,14 @@ func extractInspectV2(pk []byte, r io.Reader, w io.Writer) error {
sr.SkipEncrypted(true) sr.SkipEncrypted(true)
return sr.DebugStream(os.Stdout) return sr.DebugStream(os.Stdout)
} }
extracted := false
for { for {
stream, err := sr.NextStream() stream, err := sr.NextStream()
if err != nil { if err != nil {
if err == io.EOF { if err == io.EOF {
if extracted {
return nil
}
return errors.New("no data found on stream") return errors.New("no data found on stream")
} }
if errors.Is(err, estream.ErrNoKey) { if errors.Is(err, estream.ErrNoKey) {
@ -61,14 +68,22 @@ func extractInspectV2(pk []byte, r io.Reader, w io.Writer) error {
} }
continue continue
} }
if extracted {
return keepFileErr{fmt.Errorf("next stream: %w", err)}
}
return fmt.Errorf("next stream: %w", err) return fmt.Errorf("next stream: %w", err)
} }
if stream.Name == "inspect.zip" { if stream.Name == "inspect.zip" {
if extracted {
return keepFileErr{errors.New("multiple inspect.zip streams found")}
}
_, err := io.Copy(w, stream) _, err := io.Copy(w, stream)
if err != nil { if err != nil {
return fmt.Errorf("reading inspect stream: %w", err) return fmt.Errorf("reading inspect stream: %w", err)
} }
return nil fmt.Println(okMsg)
extracted = true
continue
} }
if err := stream.Skip(); err != nil { if err := stream.Skip(); err != nil {
return fmt.Errorf("stream skip: %w", err) return fmt.Errorf("stream skip: %w", err)

View File

@ -24,6 +24,7 @@ import (
"crypto/x509" "crypto/x509"
"encoding/json" "encoding/json"
"encoding/pem" "encoding/pem"
"errors"
"flag" "flag"
"fmt" "fmt"
"io" "io"
@ -117,18 +118,23 @@ func main() {
fatalErr(err) fatalErr(err)
// Decrypt the inspect data // Decrypt the inspect data
msg := fmt.Sprintf("output written to %s", outputFileName)
switch { switch {
case *keyHex != "": case *keyHex != "":
err = extractInspectV1(*keyHex, input, output) err = extractInspectV1(*keyHex, input, output, msg)
case len(privateKey) != 0: case len(privateKey) != 0:
err = extractInspectV2(privateKey, input, output) err = extractInspectV2(privateKey, input, output, msg)
} }
output.Close() output.Close()
if err != nil { if err != nil {
os.Remove(outputFileName)
var keep keepFileErr
if !errors.As(err, &keep) {
os.Remove(outputFileName)
}
fatalErr(err) fatalErr(err)
} }
fmt.Println("output written to", outputFileName)
// Export xl.meta to stdout // Export xl.meta to stdout
if *export { if *export {