Documentation

James Moger

2014-04-12 c5dfd60d174a9841e64e4097cecab5aea5c422d0

 src/main/java/com/gitblit/transport/ssh/SshKey.java

@@ -2,12 +2,15 @@

import java.io.Serializable;
import java.security.PublicKey;
import java.util.Arrays;
import java.util.List;

import org.apache.commons.codec.binary.Base64;
import org.apache.sshd.common.SshException;
import org.apache.sshd.common.util.Buffer;
import org.eclipse.jgit.lib.Constants;

import com.gitblit.Constants.AccessPermission;
import com.gitblit.utils.StringUtils;

/**
@@ -30,13 +33,17 @@

   private String toString;

   private AccessPermission permission;

   public SshKey(String data) {
      this.rawData = data;
      this.permission = AccessPermission.PUSH;
   }

   public SshKey(PublicKey key) {
      this.publicKey = key;
      this.comment = "";
      this.permission = AccessPermission.PUSH;
   }

   public PublicKey getPublicKey() {
@@ -78,6 +85,46 @@
      }
   }

   /**
    * Returns true if this key may be used to clone or fetch.
    *
    * @return true if this key can be used to clone or fetch
    */
   public boolean canClone() {
      return permission.atLeast(AccessPermission.CLONE);
   }

   /**
    * Returns true if this key may be used to push changes.
    *
    * @return true if this key can be used to push changes
    */
   public boolean canPush() {
      return permission.atLeast(AccessPermission.PUSH);
   }

   /**
    * Returns the access permission for the key.
    *
    * @return the access permission for the key
    */
   public AccessPermission getPermission() {
      return permission;
   }

   /**
    * Control the access permission assigned to this key.
    *
    * @param value
    */
   public void setPermission(AccessPermission value) throws IllegalArgumentException {
      List<AccessPermission> permitted = Arrays.asList(AccessPermission.SSHPERMISSIONS);
      if (!permitted.contains(value)) {
         throw new IllegalArgumentException("Illegal SSH public key permission specified: " + value);
      }
      this.permission = value;
   }

   public String getRawData() {
      if (rawData == null && publicKey != null) {
         // build the raw data manually from the public key
@@ -108,8 +155,8 @@
            final byte [] bin = Base64.decodeBase64(Constants.encodeASCII(parts[1]));
            hash = StringUtils.getMD5(bin);
         } else {
            // TODO get hash from publickey
            hash = "todo";
            // TODO calculate the correct hash from a PublicKey instance
            hash = StringUtils.getMD5(getPublicKey().getEncoded());
         }
         for (int i = 0; i < hash.length(); i += 2) {
            sb.append(hash.charAt(i)).append(hash.charAt(i + 1)).append(':');