com.google.gerrit.sshd.plugin.LfsPluginAuthCommand Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gerrit-plugin-api Show documentation

API for Gerrit Plugins

There is a newer version: 3.11.0-rc3

// Copyright (C) 2017 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.gerrit.sshd.plugin;

import com.google.common.flogger.FluentLogger;
import com.google.gerrit.extensions.registration.DynamicItem;
import com.google.gerrit.server.CurrentUser;
import com.google.gerrit.server.config.GerritServerConfig;
import com.google.gerrit.sshd.CommandModule;
import com.google.gerrit.sshd.SshCommand;
import com.google.inject.Inject;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.jgit.lib.Config;
import org.kohsuke.args4j.Argument;

public class LfsPluginAuthCommand extends SshCommand {
  private static final FluentLogger logger = FluentLogger.forEnclosingClass();

  private static final String CONFIGURATION_ERROR =
      "Server configuration error: LFS auth over SSH is not properly configured.";

  public interface LfsSshPluginAuth {
    String authenticate(CurrentUser user, List args) throws UnloggedFailure, Failure;
  }

  public static class LfsPluginAuthCommandModule extends CommandModule {
    private final boolean pluginProvided;

    @Inject
    LfsPluginAuthCommandModule(@GerritServerConfig Config cfg) {
      super(/* slaveMode= */ false);
      pluginProvided = cfg.getString("lfs", null, "plugin") != null;
    }

    @Override
    protected void configure() {
      if (pluginProvided) {
        command("git-lfs-authenticate").to(LfsPluginAuthCommand.class);
        DynamicItem.itemOf(binder(), LfsSshPluginAuth.class);
      }
    }
  }

  private final DynamicItem auth;

  @Argument(index = 0, multiValued = true, metaVar = "PARAMS")
  private List args = new ArrayList<>();

  @Inject
  LfsPluginAuthCommand(DynamicItem auth) {
    this.auth = auth;
  }

  @Override
  protected void run() throws UnloggedFailure, Exception {
    LfsSshPluginAuth pluginAuth = auth.get();
    if (pluginAuth == null) {
      logger.atWarning().log(CONFIGURATION_ERROR);
      throw new UnloggedFailure(1, CONFIGURATION_ERROR);
    }

    stdout.print(pluginAuth.authenticate(user, args));
  }
}