edu.uiuc.ncsa.myproxy.oa4mp.server.admin.adminClient.AdminClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of server-api Show documentation
The newest version!
package edu.uiuc.ncsa.myproxy.oa4mp.server.admin.adminClient;

import edu.uiuc.ncsa.oa4mp.delegation.common.storage.clients.BaseClient;
import edu.uiuc.ncsa.security.core.Identifier;
import edu.uiuc.ncsa.security.util.crypto.KeyUtil;
import net.sf.json.JSONObject;

import java.net.URI;
import java.security.NoSuchAlgorithmException;
import java.security.PublicKey;
import java.security.spec.InvalidKeySpecException;
import java.util.Base64;

import static edu.uiuc.ncsa.security.core.util.BeanUtils.checkEquals;

public class AdminClient extends BaseClient {
    /**
     *  The maximum number of OIDC (i.e. standard) clients an admin client may create before
     *  being refused by the system. This is to prevent error (e.g. an admin client is used in a
     *  script which is misbehaving). This may be increased and is simply the default for newly
     *  created admin clients.
     */
    public static int DEFAULT_MAX_NUMBER_OF_OIDC_CLIENTS = 50;

    /**
     * Store in the config for this user. This will be used for secure communication.
     */
    public static String PUBLIC_KEY_KEY = "public_key";
/*
    // Proposed to allow for more latitude for some admin clients. Not really needed.
    // Stored as a boolean in the config. Must be true to be treated as a root
    public static String ROOT_USER_KEY = "root";
    public boolean isRootUser(){
        if(hasConfig()){
           return getConfig().getBoolean(ROOT_USER_KEY);
        }
        return false;
    }
    public void setRootUser(boolean isRootUser){
        getConfig().put(ROOT_USER_KEY, isRootUser);
    }
*/
    public PublicKey getPublicKey() throws InvalidKeySpecException, NoSuchAlgorithmException {
        // The stored format of the public key is x509 public key format that is base64 encoded. This make sure that there
        // can be no issues with charsets or munged characters.
        if(!hasConfig()){
            return null;
        }
        if(!getConfig().containsKey(PUBLIC_KEY_KEY)){
            return null;
        }
        String raw = getConfig().getString(PUBLIC_KEY_KEY);
        if(raw.isEmpty()){
            return null;
        }
        byte[] bytes = Base64.getDecoder().decode(raw);
        String x509 = new String(bytes);
        return KeyUtil.fromX509PEM(x509);
    }

    public void setPublicKey(PublicKey publicKey){
        String key = KeyUtil.toX509PEM(publicKey);
        String encoded = Base64.getEncoder().encodeToString(key.getBytes());
        getConfig().put(PUBLIC_KEY_KEY, encoded);
    }
    public boolean hasConfig(){
        return getConfig() != null && !getConfig().isEmpty();
    }
    public AdminClient(Identifier identifier) {
        super(identifier);
    }

    Identifier virtualOrganization;
    String issuer;

    public String getIssuer() {
        return issuer;
    }

    public void setIssuer(String issuer) {
        this.issuer = issuer;
    }

    /**
     * The  name, used by external applications for their VO. These names have nothing to do
     * with OA4MP's virtual organization mechanisms and are typically just displayed to the
     * user at some point.
     * @return
     */
    public String getExternalVOName() {
        return externalVOName;
    }

    public void setExternalVOName(String externalVOName) {
        this.externalVOName = externalVOName;
    }

    String externalVOName;

    public Identifier getVirtualOrganization() {
        return virtualOrganization;
    }

    public void setVirtualOrganization(Identifier virtualOrganization) {
        this.virtualOrganization = virtualOrganization;
    }

    int maxClients = DEFAULT_MAX_NUMBER_OF_OIDC_CLIENTS;
     JSONObject config;

    public JSONObject getConfig() {
        return config;
    }

    public void setConfig(JSONObject config) {
        this.config = config;
    }

    /**
     * The maximum number of standard clients this admin client can create before the system
     * refuses to accept any more.
     * @return
     */
    public int getMaxClients() {
        return maxClients;
    }

    public void setMaxClients(int maxClients) {
        this.maxClients = maxClients;
    }

    @Override
    public boolean equals(Object obj) {
        if (!(obj instanceof AdminClient)) {
            return false;
        }
        AdminClient ac = (AdminClient) obj;
        if (!checkEquals(getIssuer(), ac.getIssuer())) return false;
        if (!checkEquals(getVirtualOrganization(), ac.getVirtualOrganization())) return false;
        if(getMaxClients() != ac.getMaxClients()) return false;
        return super.equals(obj);
    }

    @Override
    public BaseClient clone() {
        AdminClient ac = new AdminClient(getIdentifier());
        populateClone(ac);
        return ac;
    }

    @Override
    protected void populateClone(BaseClient client) {
        AdminClient c = (AdminClient) client;
        super.populateClone(c);
        c.setCreationTS(getCreationTS());
        c.setEmail(getEmail());
        c.setName(getName());
        c.setSecret(getSecret());
        c.setMaxClients(getMaxClients());
    }

    public boolean isAllowQDL() {
        return allowQDL;
    }

    public void setAllowQDL(boolean allowQDL) {
        this.allowQDL = allowQDL;
    }

    boolean allowQDL = false;

    public boolean allowQDLCodeBlocks() {
        return allowQDLCodeBlocks;
    }

    public void setAllowQDLCodeBlocks(boolean allowQDLCodeBlocks) {
        this.allowQDLCodeBlocks = allowQDLCodeBlocks;
    }

    boolean allowQDLCodeBlocks = false;

    @Override
    public String toString() {
        return "AdminClient{" +
                "virtualOrganization='" + virtualOrganization + '\'' +
                ", issuer='" + issuer + '\'' +
                ", maxClients=" + maxClients +
                ", config=" + config +
                ", new client notity=" + notifyOnNewClientCreate +
                '}';
    }

    /**
     *  CIL-607 required a better way to do this for more than new client notifications.
     *  Use {@link #isDebugOn()} instead.
     * @return
     * @deprecated 
     */
    public boolean isNotifyOnNewClientCreate() {
        return notifyOnNewClientCreate;
    }

    public void setNotifyOnNewClientCreate(boolean notifyOnNewClientCreate) {
        this.notifyOnNewClientCreate = notifyOnNewClientCreate;
    }

    boolean notifyOnNewClientCreate = false;

    boolean listUsers = false;
    boolean listUserInOtherClients = false;

    /**
     * If this client can list information about a given users tokens.
     * @return
     */
    public boolean isListUsers() {
        return listUsers;
    }

    public void setListUsers(boolean listUsers) {
        this.listUsers = listUsers;
    }

    /**
     * If this client can list information about a given user's tokens from other
     * clients. This implies that {@link #isListUsers()} is true.
     * @return
     */
    public boolean isListUsersInOtherClients() {
        return listUserInOtherClients;
    }

    public void setListUsersInOtherClients(boolean listUserInOtherClients) {
        this.listUserInOtherClients = listUserInOtherClients;
    }

    public boolean isAllowCustomIDs() {
        return allowCustomIDs;
    }

    public void setAllowCustomIDs(boolean allowCustomIDs) {
        this.allowCustomIDs = allowCustomIDs;
    }

    public boolean isGenerateIDs() {
        return generateIDs;
    }

    public void setGenerateIDs(boolean generateIDs) {
        this.generateIDs = generateIDs;
    }

    public URI getIdHead() {
        return idHead;
    }

    public void setIdHead(URI idHead) {
        this.idHead = idHead;
    }

    boolean allowCustomIDs = false;
    boolean generateIDs = false;
    URI idHead = null;

    public boolean isUseTimestampInIDs() {
        return useTimestampInIDs;
    }

    public void setUseTimestampInIDs(boolean useTimestampInIDs) {
        this.useTimestampInIDs = useTimestampInIDs;
    }

    boolean useTimestampInIDs = true;
}