Files
38b1e743ba inspect: Add pool parameter to extract data from a specific pool (#521)
Useful to inspect leftover data from a decommissioned pool.

Co-authored-by: Anis Eleuch <[email protected]>
2026-01-16 12:10:46 +01:00

114 lines
2.9 KiB
Go

//
// Copyright (c) 2015-2024 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
package madmin
import (
"bufio"
"context"
"encoding/base64"
"errors"
"io"
"net/http"
"net/url"
"strconv"
)
// InspectOptions provides options to Inspect.
type InspectOptions struct {
Volume, File string
PublicKey []byte // PublicKey to use for inspected data.
PoolIdx *int // Pool to fetch. nil = fetch from all.
}
// Inspect makes an admin call to download a raw files from disk.
// If inspect is called with a public key no key will be returned
// and the data is returned encrypted with the public key.
func (adm *AdminClient) Inspect(ctx context.Context, d InspectOptions) (key []byte, c io.ReadCloser, err error) {
// Add form key/values in the body
form := make(url.Values)
form.Set("volume", d.Volume)
form.Set("file", d.File)
if d.PublicKey != nil {
form.Set("public-key", base64.StdEncoding.EncodeToString(d.PublicKey))
}
if d.PoolIdx != nil {
form.Set("pool", strconv.Itoa(*d.PoolIdx))
}
method := ""
reqData := requestData{
relPath: adminAPIPrefix + "/inspect-data",
}
// If the public-key is specified, create a POST request and send
// parameters as multipart-form instead of query values
if d.PublicKey != nil {
method = http.MethodPost
reqData.customHeaders = make(http.Header)
reqData.customHeaders.Set("Content-Type", "application/x-www-form-urlencoded")
reqData.content = []byte(form.Encode())
} else {
method = http.MethodGet
reqData.queryValues = form
}
resp, err := adm.executeMethod(ctx, method, reqData)
if err != nil {
return nil, nil, err
}
if resp.StatusCode != http.StatusOK {
return nil, nil, httpRespToErrorResponse(resp)
}
bior := bufio.NewReaderSize(resp.Body, 4<<10)
format, err := bior.ReadByte()
if err != nil {
closeResponse(resp)
return nil, nil, err
}
switch format {
case 1:
key = make([]byte, 32)
// Read key...
_, err = io.ReadFull(bior, key[:])
if err != nil {
closeResponse(resp)
return nil, nil, err
}
case 2:
if err := bior.UnreadByte(); err != nil {
return nil, nil, err
}
default:
closeResponse(resp)
return nil, nil, errors.New("unknown data version")
}
// Return body
return key, &closeWrapper{Reader: bior, Closer: resp.Body}, nil
}
type closeWrapper struct {
io.Reader
io.Closer
}