)
func main() {
- err := doMain()
+ err := doMain(os.Args[1:])
if err != nil {
log.Fatalf("%v", err)
}
}
-func doMain() error {
+func doMain(args []string) error {
flags := flag.NewFlagSet("keep-block-check", flag.ExitOnError)
configFile := flags.String(
"",
"Block hash prefix. When a prefix is specified, only hashes listed in the file with this prefix will be checked.")
+ blobSigningTTL := flags.Duration(
+ "blob-signing-ttl",
+ 0*time.Second,
+ "Lifetime of blob permission signatures on the keepservers. If not provided, this will be retrieved from the keepservers.")
+
+ verbose := flags.Bool(
+ "v",
+ false,
+ "Log progress of each block verification")
+
// Parse args; omit the first arg which is the command name
- flags.Parse(os.Args[1:])
+ flags.Parse(args)
config, blobSigningKey, err := loadConfig(*configFile)
if err != nil {
}
// get list of block locators to be checked
- blockLocators, err := getBlockLocators(*locatorFile)
+ blockLocators, err := getBlockLocators(*locatorFile, *prefix)
if err != nil {
return fmt.Errorf("Error reading block hashes to be checked from file: %s", err.Error())
}
// setup keepclient
- kc, err := setupKeepClient(config, *keepServicesJSON)
+ kc, err := setupKeepClient(config, *keepServicesJSON, *blobSigningTTL)
if err != nil {
return fmt.Errorf("Error configuring keepclient: %s", err.Error())
}
- return performKeepBlockCheck(kc, blobSigningKey, *prefix, blockLocators)
+ return performKeepBlockCheck(kc, *blobSigningTTL, blobSigningKey, blockLocators, *verbose)
}
type apiConfig struct {
// Load config from given file
func loadConfig(configFile string) (config apiConfig, blobSigningKey string, err error) {
if configFile == "" {
- err = errors.New("API config file not specified")
+ err = errors.New("Client config file not specified")
return
}
}
kv := strings.SplitN(line, "=", 2)
- key := strings.TrimSpace(kv[0])
- value := strings.TrimSpace(kv[1])
-
- switch key {
- case "ARVADOS_API_TOKEN":
- config.APIToken = value
- case "ARVADOS_API_HOST":
- config.APIHost = value
- case "ARVADOS_API_HOST_INSECURE":
- config.APIHostInsecure = matchTrue.MatchString(value)
- case "ARVADOS_EXTERNAL_CLIENT":
- config.ExternalClient = matchTrue.MatchString(value)
- case "ARVADOS_BLOB_SIGNING_KEY":
- blobSigningKey = value
+ if len(kv) == 2 {
+ key := strings.TrimSpace(kv[0])
+ value := strings.TrimSpace(kv[1])
+
+ switch key {
+ case "ARVADOS_API_TOKEN":
+ config.APIToken = value
+ case "ARVADOS_API_HOST":
+ config.APIHost = value
+ case "ARVADOS_API_HOST_INSECURE":
+ config.APIHostInsecure = matchTrue.MatchString(value)
+ case "ARVADOS_EXTERNAL_CLIENT":
+ config.ExternalClient = matchTrue.MatchString(value)
+ case "ARVADOS_BLOB_SIGNING_KEY":
+ blobSigningKey = value
+ }
}
}
}
// setup keepclient using the config provided
-func setupKeepClient(config apiConfig, keepServicesJSON string) (kc *keepclient.KeepClient, err error) {
+func setupKeepClient(config apiConfig, keepServicesJSON string, blobSigningTTL time.Duration) (kc *keepclient.KeepClient, err error) {
arv := arvadosclient.ArvadosClient{
ApiToken: config.APIToken,
ApiServer: config.APIHost,
}
}
+ // Get if blobSigningTTL is not provided
+ if blobSigningTTL == 0 {
+ value, err := arv.Discovery("blobSignatureTtl")
+ if err == nil {
+ blobSigningTTL = time.Duration(int(value.(float64))) * time.Second
+ } else {
+ return nil, err
+ }
+ }
+
return
}
// Get list of unique block locators from the given file
-func getBlockLocators(locatorFile string) (locators []string, err error) {
+func getBlockLocators(locatorFile, prefix string) (locators []string, err error) {
if locatorFile == "" {
err = errors.New("block-hash-file not specified")
return
}
content, err := ioutil.ReadFile(locatorFile)
-
if err != nil {
return
}
- locatorMap := make(map[string]string)
- lines := strings.Split(string(content), "\n")
- for _, line := range lines {
- if line == "" {
+ locatorMap := make(map[string]bool)
+ for _, line := range strings.Split(string(content), "\n") {
+ line = strings.TrimSpace(line)
+ if line == "" || !strings.HasPrefix(line, prefix) || locatorMap[line] {
continue
}
- trimmedLine := strings.TrimSpace(line)
- locatorMap[trimmedLine] = trimmedLine
- }
-
- for _, locator := range locatorMap {
- locators = append(locators, locator)
+ locators = append(locators, line)
+ locatorMap[line] = true
}
return
}
// Get block headers from keep. Log any errors.
-func performKeepBlockCheck(kc *keepclient.KeepClient, blobSigningKey, prefix string, blockLocators []string) error {
- totalBlocks := 0
+func performKeepBlockCheck(kc *keepclient.KeepClient, blobSigningTTL time.Duration, blobSigningKey string, blockLocators []string, verbose bool) error {
+ totalBlocks := len(blockLocators)
notFoundBlocks := 0
+ current := 0
for _, locator := range blockLocators {
- if !strings.HasPrefix(locator, prefix) {
- continue
+ current++
+ if verbose {
+ log.Printf("Verifying block %d of %d: %v", current, totalBlocks, locator)
}
-
- totalBlocks++
getLocator := locator
if blobSigningKey != "" {
expiresAt := time.Now().AddDate(0, 0, 1)
- getLocator = keepclient.SignLocator(locator, kc.Arvados.ApiToken, expiresAt, []byte(blobSigningKey))
+ getLocator = keepclient.SignLocator(locator, kc.Arvados.ApiToken, expiresAt, blobSigningTTL, []byte(blobSigningKey))
}
_, _, err := kc.Ask(getLocator)
if err != nil {
notFoundBlocks++
- log.Printf("Error getting head info for block: %v %v", locator, err)
+ log.Printf("Error verifying block %v: %v", locator, err)
}
}
+
+ log.Printf("Verify block totals: %d attempts, %d successes, %d errors", totalBlocks, totalBlocks-notFoundBlocks, notFoundBlocks)
+
if notFoundBlocks > 0 {
- return fmt.Errorf("Head information not found for %d out of %d blocks with matching prefix.", notFoundBlocks, totalBlocks)
+ return fmt.Errorf("Block verification failed for %d out of %d blocks with matching prefix.", notFoundBlocks, totalBlocks)
}
return nil