ch.cern.ACLAugment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cerndb-sw-zkpolicy Show documentation
zkpolicy - ZooKeeper Policy Auditing Tool
There is a newer version: 1.0.1-21
/*
* Copyright © 2020, CERN
* This software is distributed under the terms of the MIT Licence,
* copied verbatim in the file 'LICENSE'. In applying this licence,
* CERN does not waive the privileges and immunities
* granted to it by virtue of its status as an Intergovernmental Organization
* or submit itself to any jurisdiction.
*/
package ch.cern;

import lombok.EqualsAndHashCode;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.zookeeper.ZooDefs;
import org.apache.zookeeper.data.ACL;
import org.apache.zookeeper.data.Id;

/**
 * Class that augments ZooKeeper ACL with field checking and comparison
 * functionality.
 */
@EqualsAndHashCode
public class ACLAugment {
  private ACL acl;

  /**
   * Construct ACLAugment from ACL object.
   *
   * @param initACL ZooKeeper ACL object.
   */
  public ACLAugment(ACL initACL) {
    this.acl = initACL;
  }

  /**
   * Construct ACLAugment from "scheme:id:permissions" string.
   *
   * @param stringACL String in scheme:id:permissions format
   */
  public ACLAugment(String stringACL) throws IllegalArgumentException {
    if (stringACL == null) {
      throw new IllegalArgumentException("Null stringACL provided");
    }

    int firstColon = stringACL.indexOf(':');
    int lastColon = stringACL.lastIndexOf(':');
    if (firstColon == -1 || lastColon == -1 || firstColon == lastColon) {
      throw new IllegalArgumentException(stringACL + " does not have the form scheme:id:perm");
    }
    String scheme = stringACL.substring(0, firstColon);

    if (!ZKPolicyDefs.Schemes.includes(scheme)) {
      throw new IllegalArgumentException(scheme + " is not a valid scheme type");
    }

    String id = stringACL.substring(firstColon + 1, lastColon);
    String perms = stringACL.substring(lastColon + 1);
    ACL newAcl = new ACL();
    newAcl.setId(new Id(scheme, id));
    newAcl.setPerms(getPermFromString(perms));
    this.acl = newAcl;
  }

  /**
   * Check if this ACL provides READ permission.
   *
   * @return True if ACL has the READ bit enabled.
   */
  public boolean hasRead() {
    return (this.acl.getPerms() & ZooDefs.Perms.READ) != 0;
  }

  /**
   * Check if this ACL provides WRITE permission.
   *
   * @return True if ACL has the WRITE bit enabled.
   */
  public boolean hasWrite() {
    return (this.acl.getPerms() & ZooDefs.Perms.WRITE) != 0;
  }

  /**
   * Check if this ACL provides CREATE permission.
   *
   * @return True if ACL has the CREATE bit enabled.
   */
  public boolean hasCreate() {
    return (this.acl.getPerms() & ZooDefs.Perms.CREATE) != 0;
  }

  /**
   * Check if this ACL provides DELETE permission.
   *
   * @return True if ACL has the DELETE bit enabled.
   */
  public boolean hasDelete() {
    return (this.acl.getPerms() & ZooDefs.Perms.DELETE) != 0;
  }

  /**
   * Check if this ACL provides ADMIN permission.
   *
   * @return True if ACL has the ADMIN bit enabled.
   */
  public boolean hasAdmin() {
    return (this.acl.getPerms() & ZooDefs.Perms.ADMIN) != 0;
  }

  /**
   * Get scheme field of ACL.
   *
   * @return Scheme of ACL.
   */
  public String getScheme() {
    return this.acl.getId().getScheme();
  }

  /**
   * Get id field of ACL.
   *
   * @return ID of ACL.
   */
  public String getId() {
    return this.acl.getId().getId();
  }

  /**
   * Get perm field of ACL.
   *
   * @return int permission representation of crwda bit sequence.
   */
  public int getPerms() {
    return this.acl.getPerms();
  }

  /**
   * Get the ACL object.
   *
   * @return ACL object encapsulated in the ACLAugment.
   */
  public ACL getACL() {
    return this.acl;
  }

  // From ZK 3.5.5 org.apache.zookeeper.cli.AclParser.java, not available on ZK
  // 3.4
  private static int getPermFromString(String permString) throws IllegalArgumentException {
    int perm = 0;
    for (int i = 0; i < permString.length(); i++) {
      switch (permString.charAt(i)) {
        case 'r':
          perm |= ZooDefs.Perms.READ;
          break;
        case 'w':
          perm |= ZooDefs.Perms.WRITE;
          break;
        case 'c':
          perm |= ZooDefs.Perms.CREATE;
          break;
        case 'd':
          perm |= ZooDefs.Perms.DELETE;
          break;
        case 'a':
          perm |= ZooDefs.Perms.ADMIN;
          break;
        default:
          throw new IllegalArgumentException("Unknown perm type: " + permString.charAt(i));
      }
    }
    return perm;
  }

  /**
   * Get ACL element in scheme:id:permissions String format.
   *
   * @return ACL element string in scheme:id:permissions format.
   */
  public String getStringFromACL() {
    String returnACL = getScheme() + ":" + getId() + ":";
    if (this.hasCreate()) {
      returnACL += "c";
    }
    if (this.hasDelete()) {
      returnACL += "d";
    }
    if (this.hasRead()) {
      returnACL += "r";
    }
    if (this.hasWrite()) {
      returnACL += "w";
    }
    if (this.hasAdmin()) {
      returnACL += "a";
    }
    return returnACL;
  }

  /**
   * Return List of ACLAugment elements from a list from ACL.
   * 
   * @param aclList ACL List from ZooKeeper
   * @return ACLAugment List
   */
  public static List generateACLAugmentList(List aclList) {
    List toReturnList = new ArrayList();
    for (ACL acl : aclList) {
      toReturnList.add(new ACLAugment(acl));
    }
    return toReturnList;
  }

  /**
   * Create String from ACL list.
   * @param aclList
   * @return Comma separated string of ACL entries
   */
  public static String generateACLStringList(List aclList) {
    StringBuffer outputBuf = new StringBuffer();
    Iterator iterator = aclList.iterator();

    while (iterator.hasNext()) {
      ACLAugment tempACL = new ACLAugment(iterator.next());
      if (iterator.hasNext()) {
        outputBuf.append(tempACL.getStringFromACL() + ", ");
      } else {
        outputBuf.append(tempACL.getStringFromACL());
      }
    }
    return outputBuf.toString();
  }
}