// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.cmscore.base;

import java.io.IOException;
import java.math.BigInteger;
import java.security.NoSuchAlgorithmException;
import java.security.NoSuchProviderException;
import java.security.SignatureException;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.StringTokenizer;

import netscape.security.pkcs.PKCS10;

import com.netscape.certsrv.apps.CMS;
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.IArgBlock;
import com.netscape.certsrv.base.KeyGenInfo;
import com.netscape.cmsutil.util.Utils;

/**
 * This class represents a set of indexed arguments.
 * Each argument is indexed by a key, which can be
 * used during the argument retrieval.
 *
 * @version $Revision$, $Date$
 */
public class ArgBlock implements IArgBlock {

    /**
     *
     */
    private static final long serialVersionUID = -6054531129316353282L;
    /*==========================================================
     * variables
     *==========================================================*/
    public static final String CERT_NEW_REQUEST_HEADER = "-----BEGIN NEW CERTIFICATE REQUEST-----";
    public static final String CERT_NEW_REQUEST_TRAILER = "-----END NEW CERTIFICATE REQUEST-----";
    public static final String CERT_REQUEST_HEADER = "-----BEGIN CERTIFICATE REQUEST-----";
    public static final String CERT_REQUEST_TRAILER = "-----END CERTIFICATE REQUEST-----";
    public static final String CERT_RENEWAL_HEADER = "-----BEGIN RENEWAL CERTIFICATE REQUEST-----";
    public static final String CERT_RENEWAL_TRAILER = "-----END RENEWAL CERTIFICATE REQUEST-----";

    private Hashtable<String, Object> mArgs = new Hashtable<String, Object>();

    private String mType = "unspecified-argblock";

    /*==========================================================
     * constructors
     *==========================================================*/
    /**
     * Constructs an argument block with the given hashtable values.
     *
     * @param realm the type of argblock - used for debugging the values
     */
    public ArgBlock(String realm, Hashtable<String, String> httpReq) {
        mType = realm;
        populate(httpReq);
    }

    /**
     * Constructs an argument block with the given hashtable values.
     *
     * @param httpReq hashtable keys and values
     */
    public ArgBlock(Hashtable<String, String> httpReq) {
        populate(httpReq);
    }

    private void populate(Hashtable<String, String> httpReq) {
        // Add all parameters from the request
        Enumeration<String> e = httpReq.keys();

        if (e != null) {
            while (e.hasMoreElements()) {
                String name = e.nextElement();
                String value = httpReq.get(name);

                addStringValue(name, value);
            }
        }
    }

    /**
     * Constructs an empty argument block.
     */
    public ArgBlock() {
    }

    /*==========================================================
     * public methods
     *==========================================================*/

    /**
     * Checks if this argument block contains the given key.
     *
     * @param n key
     * @return true if key is present
     */
    public boolean isValuePresent(String n) {
        CMS.traceHashKey(mType, n);
        if (mArgs.get(n) != null) {
            return true;
        } else {
            return false;
        }
    }

    /**
     * Adds string-based value into this argument block.
     *
     * @param n key
     * @param v value
     * @return value
     */
    public Object addStringValue(String n, String v) {
        if (v == null) {
            return mArgs.put(n, Character.valueOf((char) 0));
        } else {
            return mArgs.put(n, v);
        }
    }

    /**
     * Retrieves argument value as string.
     *
     * @param n key
     * @return argument value as string
     * @exception EBaseException failed to retrieve value
     */
    public String getValueAsString(String n) throws EBaseException {
        String t = (String) mArgs.get(n);
        CMS.traceHashKey(mType, n, t);

        if (t != null) {
            return t;
        } else {
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_ATTRIBUTE_NOT_FOUND", n));
        }
    }

    /**
     * Retrieves argument value as string.
     *
     * @param n key
     * @param def default value to be returned if key is not present
     * @return argument value as string
     */
    public String getValueAsString(String n, String def) {
        String val = (String) mArgs.get(n);
        CMS.traceHashKey(mType, n, val, def);

        if (val != null) {
            return val;
        } else {
            return def;
        }
    }

    /**
     * Retrieves argument value as integer.
     *
     * @param n key
     * @return argument value as int
     * @exception EBaseException failed to retrieve value
     */
    public int getValueAsInt(String n) throws EBaseException {
        if (mArgs.get(n) != null) {
            CMS.traceHashKey(mType, n, (String) mArgs.get(n));
            try {
                return new Integer((String) mArgs.get(n)).intValue();
            } catch (NumberFormatException e) {
                throw new EBaseException(
                        CMS.getUserMessage("CMS_BASE_INVALID_ATTR_TYPE", n, e.toString()));
            }
        } else {
            CMS.traceHashKey(mType, n, "<notpresent>");
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_ATTRIBUTE_NOT_FOUND", n));
        }
    }

    /**
     * Retrieves argument value as integer.
     *
     * @param n key
     * @param def default value to be returned if key is not present
     * @return argument value as int
     */
    public int getValueAsInt(String n, int def) {
        CMS.traceHashKey(mType, n, (String) mArgs.get(n), "" + def);
        if (mArgs.get(n) != null) {
            try {
                return new Integer((String) mArgs.get(n)).intValue();
            } catch (NumberFormatException e) {
                return def;
            }
        } else {
            return def;
        }
    }

    /**
     * Retrieves argument value as big integer.
     *
     * @param n key
     * @return argument value as big integer
     * @exception EBaseException failed to retrieve value
     */
    public BigInteger getValueAsBigInteger(String n)
            throws EBaseException {
        String v = (String) mArgs.get(n);

        if (v != null) {
            try {
                return new BigInteger(v, 10);
            } catch (NumberFormatException e) {
                try {
                    return new BigInteger(v, 16);
                } catch (NumberFormatException ex) {
                    throw new EBaseException(
                            CMS.getUserMessage("CMS_BASE_INVALID_ATTR_TYPE", n, ex.toString()));
                }
            }
        } else {
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_ATTRIBUTE_NOT_FOUND", n));
        }
    }

    /**
     * Retrieves argument value as big integer.
     *
     * @param n key
     * @param def default value to be returned if key is not present
     * @return argument value as big integer
     */
    public BigInteger getValueAsBigInteger(String n, BigInteger def) {
        try {
            return getValueAsBigInteger(n);
        } catch (EBaseException e) {
            return def;
        }
    }

    /**
     * Retrieves argument value as object
     *
     * @param n key
     * @return argument value as object
     * @exception EBaseException failed to retrieve value
     */
    public Object getValue(Object n) throws EBaseException {
        if (mArgs.get(n) != null) {
            return mArgs.get(n);
        } else {
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_ATTRIBUTE_NOT_FOUND", (String) n));
        }
    }

    /**
     * Retrieves argument value as object
     *
     * @param n key
     * @param def default value to be returned if key is not present
     * @return argument value as object
     */
    public Object getValue(Object n, Object def) {
        if (mArgs.get(n) != null) {
            return mArgs.get(n);
        } else {
            return def;
        }
    }

    /**
     * Gets boolean value. They should be "true" or "false".
     *
     * @param name name of the input type
     * @return boolean type: <code>true</code> or <code>false</code>
     * @exception EBaseException failed to retrieve value
     */
    public boolean getValueAsBoolean(String name) throws EBaseException {
        String val = (String) mArgs.get(name);
        CMS.traceHashKey(mType, name, val);

        if (val != null) {
            if (val.equalsIgnoreCase("true") ||
                    val.equalsIgnoreCase("on"))
                return true;
            else
                return false;
        } else {
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_ATTRIBUTE_NOT_FOUND", name));
        }
    }

    /**
     * Gets boolean value. They should be "true" or "false".
     *
     * @param name name of the input type
     * @return boolean type: <code>true</code> or <code>false</code>
     */
    public boolean getValueAsBoolean(String name, boolean def) {
        boolean val;

        try {
            val = getValueAsBoolean(name);
            return val;
        } catch (EBaseException e) {
            return def;
        }
    }

    /**
     * Gets KeyGenInfo
     *
     * @param name name of the input type
     * @param verify true if signature validation is required
     * @exception EBaseException
     * @return KeyGenInfo object
     */
    public KeyGenInfo getValueAsKeyGenInfo(String name, KeyGenInfo def)
            throws EBaseException {
        KeyGenInfo keyGenInfo;

        CMS.traceHashKey(mType, name);
        if (mArgs.get(name) != null) {
            try {
                keyGenInfo = new KeyGenInfo((String) mArgs.get(name));
            } catch (IOException e) {
                return def;
            }

        } else {
            return def;
        }
        return keyGenInfo;
    }

    /**
     * Gets PKCS10 request. This pkcs10 attribute does not
     * contain header information.
     *
     * @param name name of the input type
     * @return pkcs10 request
     * @exception EBaseException failed to retrieve value
     */
    public PKCS10 getValueAsRawPKCS10(String name) throws EBaseException {
        PKCS10 request;

        if (mArgs.get(name) != null) {
            CMS.traceHashKey(mType, name, (String) mArgs.get(name));

            String tempStr = unwrap((String) mArgs.get(name), false);

            if (tempStr == null) {
                throw new EBaseException(
                        CMS.getUserMessage("CMS_BASE_INVALID_ATTR_VALUE", name, "Empty Content"));
            }
            try {
                request = decodePKCS10(tempStr);
            } catch (Exception e) {
                throw new EBaseException(
                        CMS.getUserMessage("CMS_BASE_INVALID_ATTR_VALUE", name, e.toString()));
            }
        } else {
            CMS.traceHashKey(mType, name, "<notpresent>");
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_ATTRIBUTE_NOT_FOUND", name));
        }

        return request;
    }

    /**
     * Gets PKCS10 request. This pkcs10 attribute does not
     * contain header information.
     *
     * @param name name of the input type
     * @param def default PKCS10
     * @return pkcs10 request
     * @exception EBaseException failed to retrieve value
     */
    public PKCS10 getValueAsRawPKCS10(String name, PKCS10 def)
            throws EBaseException {
        PKCS10 request;

        CMS.traceHashKey(mType, name);
        if (mArgs.get(name) != null) {

            String tempStr = unwrap((String) mArgs.get(name), false);

            if (tempStr == null) {
                return def;
            }
            try {
                request = decodePKCS10(tempStr);
            } catch (Exception e) {
                return def;
            }
        } else {
            return def;
        }
        return request;
    }

    /**
     * Retrieves PKCS10
     *
     * @param name name of the input type
     * @param checkheader true if header must be present
     * @return PKCS10 object
     * @exception EBaseException failed to retrieve value
     */
    public PKCS10 getValueAsPKCS10(String name, boolean checkheader)
            throws EBaseException {
        PKCS10 request;

        CMS.traceHashKey(mType, name);
        if (mArgs.get(name) != null) {

            String tempStr = unwrap((String) mArgs.get(name), checkheader);

            if (tempStr == null) {
                throw new EBaseException(
                        CMS.getUserMessage("CMS_BASE_INVALID_ATTR_VALUE", name, "Empty Content"));
            }
            try {
                request = decodePKCS10(tempStr);
            } catch (Exception e) {
                throw new EBaseException(
                        CMS.getUserMessage("CMS_BASE_INVALID_ATTR_VALUE", name, e.toString()));
            }
        } else {
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_ATTRIBUTE_NOT_FOUND", name));
        }

        return request;
    }

    /**
     * Retrieves PKCS10
     *
     * @param name name of the input type
     * @param checkheader true if header must be present
     * @param def default PKCS10
     * @return PKCS10 object
     * @exception EBaseException
     */
    public PKCS10 getValueAsPKCS10(
            String name, boolean checkheader, PKCS10 def)
            throws EBaseException {
        PKCS10 request;

        CMS.traceHashKey(mType, name);

        if (mArgs.get(name) != null) {

            String tempStr = unwrap((String) mArgs.get(name), checkheader);

            if (tempStr == null) {
                return def;
            }
            try {
                request = decodePKCS10(tempStr);
            } catch (Exception e) {
                return def;
            }
        } else {
            return def;
        }

        return request;
    }

    /**
     * Retrieves PKCS10
     *
     * @param name name of the input type
     * @param def default PKCS10
     * @return PKCS10 object
     * @exception EBaseException
     */
    public PKCS10 getValuePKCS10(String name, PKCS10 def)
            throws EBaseException {
        PKCS10 request;
        String p10b64 = (String) mArgs.get(name);
        CMS.traceHashKey(mType, name);

        if (p10b64 != null) {

            try {
                request = decodePKCS10(p10b64);
                return request;
            } catch (Exception e) {
                return def;
            }
        } else {
            return def;
        }
    }

    /**
     * Sets argument into this block.
     *
     * @param name key
     * @param ob value
     */
    public void set(String name, Object ob) {
        mArgs.put(name, ob);
    }

    /**
     * Retrieves argument.
     *
     * @param name key
     * @return object value
     */
    public Object get(String name) {
        CMS.traceHashKey(mType, name);
        return mArgs.get(name);
    }

    /**
     * Deletes argument by the given key.
     *
     * @param name key
     */
    public void delete(String name) {
        mArgs.remove(name);
    }

    /**
     * Retrieves a list of argument keys.
     *
     * @return a list of string-based keys
     */
    public Enumeration<String> getElements() {
        return mArgs.keys();
    }

    /**
     * Retrieves a list of argument keys.
     *
     * @return a list of string-based keys
     */
    public Enumeration<String> elements() {
        return mArgs.keys();
    }

    /**
     * Adds long-type arguments to this block.
     *
     * @param n key
     * @param v value
     * @return value
     */
    public Object addLongValue(String n, long v) {
        return mArgs.put(n, Long.valueOf(v));
    }

    /**
     * Adds integer-type arguments to this block.
     *
     * @param n key
     * @param v value
     * @return value
     */
    public Object addIntegerValue(String n, int v) {
        return mArgs.put(n, Integer.valueOf(v));
    }

    /**
     * Adds boolean-type arguments to this block.
     *
     * @param n key
     * @param v value
     * @return value
     */
    public Object addBooleanValue(String n, boolean v) {
        return mArgs.put(n, Boolean.valueOf(v));
    }

    /**
     * Adds integer-type arguments to this block.
     *
     * @param n key
     * @param v value
     * @param radix radix
     * @return value
     */
    public Object addBigIntegerValue(String n, BigInteger v, int radix) {
        return mArgs.put(n, v.toString(radix));
    }

    /*==========================================================
     * private methods
     *==========================================================*/

    /**
     * Unwrap PKCS10 Package
     *
     * @param request string formated PKCS10 request
     * @exception EBaseException
     * @return Base64Encoded PKCS10 request
     */
    private String unwrap(String request, boolean checkHeader)
            throws EBaseException {
        String unwrapped;
        String header = null;
        int head = -1;
        int trail = -1;

        // check for "-----BEGIN NEW CERTIFICATE REQUEST-----";
        if (header == null) {
            head = request.indexOf(CERT_NEW_REQUEST_HEADER);
            trail = request.indexOf(CERT_NEW_REQUEST_TRAILER);

            if (!(head == -1 && trail == -1)) {
                header = CERT_NEW_REQUEST_HEADER;
            }
        }

        // check for "-----BEGIN CERTIFICATE REQUEST-----";
        if (header == null) {
            head = request.indexOf(CERT_REQUEST_HEADER);
            trail = request.indexOf(CERT_REQUEST_TRAILER);

            // If this is not a request header, check if this is a renewal
            // header.
            if (!(head == -1 && trail == -1)) {
                header = CERT_REQUEST_HEADER;

            }
        }

        // check for "-----BEGIN RENEWAL CERTIFICATE REQUEST-----";
        if (header == null) {
            head = request.indexOf(CERT_RENEWAL_HEADER);
            trail = request.indexOf(CERT_RENEWAL_TRAILER);
            if (!(head == -1 && trail == -1)) {
                header = CERT_RENEWAL_HEADER;
            }
        }

        // Now validate if any headers or trailers are in place
        if (head == -1 && checkHeader) {
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_MISSING_PKCS10_HEADER"));
        }
        if (trail == -1 && checkHeader) {
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_MISSING_PKCS10_TRAILER"));
        }

        if (header != null) {
            unwrapped = request.substring(head + header.length(), trail);
        } else {
            unwrapped = request;
        }

        // strip all the crtl-characters (i.e. \r\n)
        StringTokenizer st = new StringTokenizer(unwrapped, "\t\r\n ");
        StringBuffer stripped = new StringBuffer();

        while (st.hasMoreTokens()) {
            stripped.append(st.nextToken());
        }

        return stripped.toString();
    }

    /**
     * Decode Der encoded PKCS10 certifictae Request
     *
     * @param base64Request Base64 Encoded Certificate Request
     * @exception Exception
     * @return PKCS10
     */
    private PKCS10 decodePKCS10(String base64Request)
            throws EBaseException {
        PKCS10 pkcs10 = null;

        try {
            byte[] decodedBytes = Utils.base64decode(base64Request);

            pkcs10 = new PKCS10(decodedBytes);
        } catch (NoSuchProviderException e) {
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_INTERNAL_ERROR", e.toString()));
        } catch (IOException e) {
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_INTERNAL_ERROR", e.toString()));
        } catch (SignatureException e) {
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_INTERNAL_ERROR", e.toString()));
        } catch (NoSuchAlgorithmException e) {
            throw new EBaseException(CMS.getUserMessage("CMS_BASE_INTERNAL_ERROR", e.toString()));
        }

        return pkcs10;
    }

}
id='n528' href='#n528'>528</a>
<a id='n529' href='#n529'>529</a>
<a id='n530' href='#n530'>530</a>
<a id='n531' href='#n531'>531</a>
<a id='n532' href='#n532'>532</a>
<a id='n533' href='#n533'>533</a>
<a id='n534' href='#n534'>534</a>
<a id='n535' href='#n535'>535</a>
<a id='n536' href='#n536'>536</a>
<a id='n537' href='#n537'>537</a>
<a id='n538' href='#n538'>538</a>
<a id='n539' href='#n539'>539</a>
<a id='n540' href='#n540'>540</a>
<a id='n541' href='#n541'>541</a>
<a id='n542' href='#n542'>542</a>
<a id='n543' href='#n543'>543</a>
<a id='n544' href='#n544'>544</a>
<a id='n545' href='#n545'>545</a>
<a id='n546' href='#n546'>546</a>
<a id='n547' href='#n547'>547</a>
<a id='n548' href='#n548'>548</a>
<a id='n549' href='#n549'>549</a>
<a id='n550' href='#n550'>550</a>
<a id='n551' href='#n551'>551</a>
<a id='n552' href='#n552'>552</a>
<a id='n553' href='#n553'>553</a>
<a id='n554' href='#n554'>554</a>
<a id='n555' href='#n555'>555</a>
<a id='n556' href='#n556'>556</a>
<a id='n557' href='#n557'>557</a>
<a id='n558' href='#n558'>558</a>
<a id='n559' href='#n559'>559</a>
<a id='n560' href='#n560'>560</a>
<a id='n561' href='#n561'>561</a>
<a id='n562' href='#n562'>562</a>
<a id='n563' href='#n563'>563</a>
<a id='n564' href='#n564'>564</a>
<a id='n565' href='#n565'>565</a>
<a id='n566' href='#n566'>566</a>
<a id='n567' href='#n567'>567</a>
<a id='n568' href='#n568'>568</a>
<a id='n569' href='#n569'>569</a>
<a id='n570' href='#n570'>570</a>
<a id='n571' href='#n571'>571</a>
<a id='n572' href='#n572'>572</a>
<a id='n573' href='#n573'>573</a>
<a id='n574' href='#n574'>574</a>
<a id='n575' href='#n575'>575</a>
<a id='n576' href='#n576'>576</a>
<a id='n577' href='#n577'>577</a>
<a id='n578' href='#n578'>578</a>
<a id='n579' href='#n579'>579</a>
<a id='n580' href='#n580'>580</a>
<a id='n581' href='#n581'>581</a>
<a id='n582' href='#n582'>582</a>
<a id='n583' href='#n583'>583</a>
<a id='n584' href='#n584'>584</a>
<a id='n585' href='#n585'>585</a>
<a id='n586' href='#n586'>586</a>
<a id='n587' href='#n587'>587</a>
<a id='n588' href='#n588'>588</a>
<a id='n589' href='#n589'>589</a>
<a id='n590' href='#n590'>590</a>
<a id='n591' href='#n591'>591</a>
<a id='n592' href='#n592'>592</a>
<a id='n593' href='#n593'>593</a>
<a id='n594' href='#n594'>594</a>
<a id='n595' href='#n595'>595</a>
<a id='n596' href='#n596'>596</a>
<a id='n597' href='#n597'>597</a>
<a id='n598' href='#n598'>598</a>
<a id='n599' href='#n599'>599</a>
<a id='n600' href='#n600'>600</a>
<a id='n601' href='#n601'>601</a>
<a id='n602' href='#n602'>602</a>
<a id='n603' href='#n603'>603</a>
<a id='n604' href='#n604'>604</a>
<a id='n605' href='#n605'>605</a>
<a id='n606' href='#n606'>606</a>
<a id='n607' href='#n607'>607</a>
<a id='n608' href='#n608'>608</a>
<a id='n609' href='#n609'>609</a>
<a id='n610' href='#n610'>610</a>
<a id='n611' href='#n611'>611</a>
<a id='n612' href='#n612'>612</a>
<a id='n613' href='#n613'>613</a>
<a id='n614' href='#n614'>614</a>
<a id='n615' href='#n615'>615</a>
<a id='n616' href='#n616'>616</a>
<a id='n617' href='#n617'>617</a>
<a id='n618' href='#n618'>618</a>
<a id='n619' href='#n619'>619</a>
<a id='n620' href='#n620'>620</a>
<a id='n621' href='#n621'>621</a>
<a id='n622' href='#n622'>622</a>
<a id='n623' href='#n623'>623</a>
<a id='n624' href='#n624'>624</a>
<a id='n625' href='#n625'>625</a>
<a id='n626' href='#n626'>626</a>
<a id='n627' href='#n627'>627</a>
<a id='n628' href='#n628'>628</a>
<a id='n629' href='#n629'>629</a>
<a id='n630' href='#n630'>630</a>
<a id='n631' href='#n631'>631</a>
<a id='n632' href='#n632'>632</a>
<a id='n633' href='#n633'>633</a>
<a id='n634' href='#n634'>634</a>
<a id='n635' href='#n635'>635</a>
<a id='n636' href='#n636'>636</a>
<a id='n637' href='#n637'>637</a>
<a id='n638' href='#n638'>638</a>
<a id='n639' href='#n639'>639</a>
<a id='n640' href='#n640'>640</a>
<a id='n641' href='#n641'>641</a>
<a id='n642' href='#n642'>642</a>
<a id='n643' href='#n643'>643</a>
<a id='n644' href='#n644'>644</a>
<a id='n645' href='#n645'>645</a>
<a id='n646' href='#n646'>646</a>
<a id='n647' href='#n647'>647</a>
<a id='n648' href='#n648'>648</a>
<a id='n649' href='#n649'>649</a>
<a id='n650' href='#n650'>650</a>
<a id='n651' href='#n651'>651</a>
<a id='n652' href='#n652'>652</a>
<a id='n653' href='#n653'>653</a>
<a id='n654' href='#n654'>654</a>
<a id='n655' href='#n655'>655</a>
<a id='n656' href='#n656'>656</a>
<a id='n657' href='#n657'>657</a>
<a id='n658' href='#n658'>658</a>
<a id='n659' href='#n659'>659</a>
<a id='n660' href='#n660'>660</a>
<a id='n661' href='#n661'>661</a>
<a id='n662' href='#n662'>662</a>
<a id='n663' href='#n663'>663</a>
<a id='n664' href='#n664'>664</a>
<a id='n665' href='#n665'>665</a>
<a id='n666' href='#n666'>666</a>
<a id='n667' href='#n667'>667</a>
<a id='n668' href='#n668'>668</a>
<a id='n669' href='#n669'>669</a>
<a id='n670' href='#n670'>670</a>
<a id='n671' href='#n671'>671</a>
<a id='n672' href='#n672'>672</a>
<a id='n673' href='#n673'>673</a>
<a id='n674' href='#n674'>674</a>
<a id='n675' href='#n675'>675</a>
<a id='n676' href='#n676'>676</a>
<a id='n677' href='#n677'>677</a>
<a id='n678' href='#n678'>678</a>
<a id='n679' href='#n679'>679</a>
<a id='n680' href='#n680'>680</a>
<a id='n681' href='#n681'>681</a>
<a id='n682' href='#n682'>682</a>
<a id='n683' href='#n683'>683</a>
<a id='n684' href='#n684'>684</a>
<a id='n685' href='#n685'>685</a>
<a id='n686' href='#n686'>686</a>
<a id='n687' href='#n687'>687</a>
<a id='n688' href='#n688'>688</a>
<a id='n689' href='#n689'>689</a>
<a id='n690' href='#n690'>690</a>
<a id='n691' href='#n691'>691</a>
<a id='n692' href='#n692'>692</a>
<a id='n693' href='#n693'>693</a>
<a id='n694' href='#n694'>694</a>
<a id='n695' href='#n695'>695</a>
<a id='n696' href='#n696'>696</a>
<a id='n697' href='#n697'>697</a>
<a id='n698' href='#n698'>698</a>
<a id='n699' href='#n699'>699</a>
<a id='n700' href='#n700'>700</a>
<a id='n701' href='#n701'>701</a>
<a id='n702' href='#n702'>702</a>
<a id='n703' href='#n703'>703</a>
<a id='n704' href='#n704'>704</a>
<a id='n705' href='#n705'>705</a>
<a id='n706' href='#n706'>706</a>
<a id='n707' href='#n707'>707</a>
<a id='n708' href='#n708'>708</a>
<a id='n709' href='#n709'>709</a>
<a id='n710' href='#n710'>710</a>
<a id='n711' href='#n711'>711</a>
<a id='n712' href='#n712'>712</a>
<a id='n713' href='#n713'>713</a>
<a id='n714' href='#n714'>714</a>
<a id='n715' href='#n715'>715</a>
</pre></td>
<td class='lines'><pre><code><span class="hl slc"># Authors:</span>
<span class="hl slc">#   Jason Gerard DeRose &lt;jderose&#64;redhat.com&gt;</span>
<span class="hl slc">#</span>
<span class="hl slc"># Copyright (C) 2008  Red Hat</span>
<span class="hl slc"># see file 'COPYING' for use and warranty information</span>
<span class="hl slc">#</span>
<span class="hl slc"># This program is free software; you can redistribute it and/or modify</span>
<span class="hl slc"># it under the terms of the GNU General Public License as published by</span>
<span class="hl slc"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="hl slc"># (at your option) any later version.</span>
<span class="hl slc">#</span>
<span class="hl slc"># This program is distributed in the hope that it will be useful,</span>
<span class="hl slc"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="hl slc"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<span class="hl slc"># GNU General Public License for more details.</span>
<span class="hl slc">#</span>
<span class="hl slc"># You should have received a copy of the GNU General Public License</span>
<span class="hl slc"># along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>

<span class="hl str">&quot;&quot;&quot;</span>
<span class="hl str">Common utility functions and classes for unit tests.</span>
<span class="hl str">&quot;&quot;&quot;</span>

<span class="hl kwa">import</span> inspect
<span class="hl kwa">import</span> os
<span class="hl kwa">from</span> os <span class="hl kwa">import</span> path
<span class="hl kwa">import</span> tempfile
<span class="hl kwa">import</span> shutil
<span class="hl kwa">import</span> re
<span class="hl kwa">import</span> uuid
<span class="hl kwa">from</span> contextlib <span class="hl kwa">import</span> contextmanager

<span class="hl kwa">import</span> six
<span class="hl kwa">import</span> ldap
<span class="hl kwa">import</span> ldap<span class="hl opt">.</span>sasl
<span class="hl kwa">import</span> ldap<span class="hl opt">.</span>modlist

<span class="hl kwa">import</span> ipalib
<span class="hl kwa">from</span> ipalib <span class="hl kwa">import</span> api
<span class="hl kwa">from</span> ipalib<span class="hl opt">.</span>plugable <span class="hl kwa">import</span> Plugin
<span class="hl kwa">from</span> ipalib<span class="hl opt">.</span>request <span class="hl kwa">import</span> context
<span class="hl kwa">from</span> ipapython<span class="hl opt">.</span>dn <span class="hl kwa">import</span> DN
<span class="hl kwa">from</span> ipapython<span class="hl opt">.</span>ipautil <span class="hl kwa">import</span> private_ccache<span class="hl opt">,</span> kinit_password<span class="hl opt">,</span> run
<span class="hl kwa">from</span> ipaplatform<span class="hl opt">.</span>paths <span class="hl kwa">import</span> paths

<span class="hl kwa">if</span> six<span class="hl opt">.</span>PY3<span class="hl opt">:</span>
    <span class="hl kwb">unicode</span> <span class="hl opt">=</span> <span class="hl kwb">str</span>


<span class="hl kwa">class</span> <span class="hl kwd">TempDir</span><span class="hl opt">(</span><span class="hl kwb">object</span><span class="hl opt">):</span>
    <span class="hl kwa">def</span> <span class="hl kwd">__init__</span><span class="hl opt">(</span>self<span class="hl opt">):</span>
        self<span class="hl opt">.</span>__path <span class="hl opt">=</span> tempfile<span class="hl opt">.</span><span class="hl kwd">mkdtemp</span><span class="hl opt">(</span>prefix<span class="hl opt">=</span><span class="hl str">'ipa.tests.'</span><span class="hl opt">)</span>
        <span class="hl kwa">assert</span> self<span class="hl opt">.</span>path <span class="hl opt">==</span> self<span class="hl opt">.</span>__path

    <span class="hl kwa">def</span> <span class="hl kwd">__get_path</span><span class="hl opt">(</span>self<span class="hl opt">):</span>
        <span class="hl kwa">assert</span> path<span class="hl opt">.</span><span class="hl kwd">abspath</span><span class="hl opt">(</span>self<span class="hl opt">.</span>__path<span class="hl opt">) ==</span> self<span class="hl opt">.</span>__path
        <span class="hl kwa">assert</span> self<span class="hl opt">.</span>__path<span class="hl opt">.</span><span class="hl kwd">startswith</span><span class="hl opt">(</span><span class="hl str">'/tmp/ipa.tests.'</span><span class="hl opt">)</span>
        <span class="hl kwa">assert</span> path<span class="hl opt">.</span><span class="hl kwd">isdir</span><span class="hl opt">(</span>self<span class="hl opt">.</span>__path<span class="hl opt">)</span> <span class="hl kwa">and not</span> path<span class="hl opt">.</span><span class="hl kwd">islink</span><span class="hl opt">(</span>self<span class="hl opt">.</span>__path<span class="hl opt">)</span>
        <span class="hl kwa">return</span> self<span class="hl opt">.</span>__path
    path <span class="hl opt">=</span> <span class="hl kwb">property</span><span class="hl opt">(</span>__get_path<span class="hl opt">)</span>

    <span class="hl kwa">def</span> <span class="hl kwd">rmtree</span><span class="hl opt">(</span>self<span class="hl opt">):</span>
        <span class="hl kwa">if</span> self<span class="hl opt">.</span>__path <span class="hl kwa">is not None</span><span class="hl opt">:</span>
            shutil<span class="hl opt">.</span><span class="hl kwd">rmtree</span><span class="hl opt">(</span>self<span class="hl opt">.</span>path<span class="hl opt">)</span>
            self<span class="hl opt">.</span>__path <span class="hl opt">=</span> <span class="hl kwa">None</span>

    <span class="hl kwa">def</span> <span class="hl kwd">makedirs</span><span class="hl opt">(</span>self<span class="hl opt">, *</span>parts<span class="hl opt">):</span>
        d <span class="hl opt">=</span> self<span class="hl opt">.</span><span class="hl kwd">join</span><span class="hl opt">(*</span>parts<span class="hl opt">)</span>
        <span class="hl kwa">if not</span> path<span class="hl opt">.</span><span class="hl kwd">exists</span><span class="hl opt">(</span>d<span class="hl opt">):</span>
            os<span class="hl opt">.</span><span class="hl kwd">makedirs</span><span class="hl opt">(</span>d<span class="hl opt">)</span>
        <span class="hl kwa">assert</span> path<span class="hl opt">.</span><span class="hl kwd">isdir</span><span class="hl opt">(</span>d<span class="hl opt">)</span> <span class="hl kwa">and not</span> path<span class="hl opt">.</span><span class="hl kwd">islink</span><span class="hl opt">(</span>d<span class="hl opt">)</span>
        <span class="hl kwa">return</span> d

    <span class="hl kwa">def</span> <span class="hl kwd">touch</span><span class="hl opt">(</span>self<span class="hl opt">, *</span>parts<span class="hl opt">):</span>
        d <span class="hl opt">=</span> self<span class="hl opt">.</span><span class="hl kwd">makedirs</span><span class="hl opt">(*</span>parts<span class="hl opt">[:-</span><span class="hl num">1</span><span class="hl opt">])</span>
        f <span class="hl opt">=</span> path<span class="hl opt">.</span><span class="hl kwd">join</span><span class="hl opt">(</span>d<span class="hl opt">,</span> parts<span class="hl opt">[-</span><span class="hl num">1</span><span class="hl opt">])</span>
        <span class="hl kwa">assert not</span> path<span class="hl opt">.</span><span class="hl kwd">exists</span><span class="hl opt">(</span>f<span class="hl opt">)</span>
        <span class="hl kwb">open</span><span class="hl opt">(</span>f<span class="hl opt">,</span> <span class="hl str">'w'</span><span class="hl opt">).</span><span class="hl kwd">close</span><span class="hl opt">()</span>
        <span class="hl kwa">assert</span> path<span class="hl opt">.</span><span class="hl kwd">isfile</span><span class="hl opt">(</span>f<span class="hl opt">)</span> <span class="hl kwa">and not</span> path<span class="hl opt">.</span><span class="hl kwd">islink</span><span class="hl opt">(</span>f<span class="hl opt">)</span>
        <span class="hl kwa">return</span> f

    <span class="hl kwa">def</span> <span class="hl kwd">write</span><span class="hl opt">(</span>self<span class="hl opt">,</span> content<span class="hl opt">, *</span>parts<span class="hl opt">):</span>
        d <span class="hl opt">=</span> self<span class="hl opt">.</span><span class="hl kwd">makedirs</span><span class="hl opt">(*</span>parts<span class="hl opt">[:-</span><span class="hl num">1</span><span class="hl opt">])</span>
        f <span class="hl opt">=</span> path<span class="hl opt">.</span><span class="hl kwd">join</span><span class="hl opt">(</span>d<span class="hl opt">,</span> parts<span class="hl opt">[-</span><span class="hl num">1</span><span class="hl opt">])</span>
        <span class="hl kwa">assert not</span> path<span class="hl opt">.</span><span class="hl kwd">exists</span><span class="hl opt">(</span>f<span class="hl opt">)</span>
        <span class="hl kwb">open</span><span class="hl opt">(</span>f<span class="hl opt">,</span> <span class="hl str">'w'</span><span class="hl opt">).</span><span class="hl kwd">write</span><span class="hl opt">(</span>content<span class="hl opt">)</span>
        <span class="hl kwa">assert</span> path<span class="hl opt">.</span><span class="hl kwd">isfile</span><span class="hl opt">(</span>f<span class="hl opt">)</span> <span class="hl kwa">and not</span> path<span class="hl opt">.</span><span class="hl kwd">islink</span><span class="hl opt">(</span>f<span class="hl opt">)</span>
        <span class="hl kwa">return</span> f

    <span class="hl kwa">def</span> <span class="hl kwd">join</span><span class="hl opt">(</span>self<span class="hl opt">, *</span>parts<span class="hl opt">):</span>
        <span class="hl kwa">return</span> path<span class="hl opt">.</span><span class="hl kwd">join</span><span class="hl opt">(</span>self<span class="hl opt">.</span>path<span class="hl opt">, *</span>parts<span class="hl opt">)</span>

    <span class="hl kwa">def</span> <span class="hl kwd">__del__</span><span class="hl opt">(</span>self<span class="hl opt">):</span>
        self<span class="hl opt">.</span><span class="hl kwd">rmtree</span><span class="hl opt">()</span>


<span class="hl kwa">class</span> <span class="hl kwd">TempHome</span><span class="hl opt">(</span>TempDir<span class="hl opt">):</span>
    <span class="hl kwa">def</span> <span class="hl kwd">__init__</span><span class="hl opt">(</span>self<span class="hl opt">):</span>
        <span class="hl kwb">super</span><span class="hl opt">(</span>TempHome<span class="hl opt">,</span> self<span class="hl opt">).</span><span class="hl kwd">__init__</span><span class="hl opt">()</span>
        self<span class="hl opt">.</span>__home <span class="hl opt">=</span> os<span class="hl opt">.</span>environ<span class="hl opt">[</span><span class="hl str">'HOME'</span><span class="hl opt">]</span>
        os<span class="hl opt">.</span>environ<span class="hl opt">[</span><span class="hl str">'HOME'</span><span class="hl opt">] =</span> self<span class="hl opt">.</span>path


<span class="hl kwa">class</span> <span class="hl kwd">ExceptionNotRaised</span><span class="hl opt">(</span><span class="hl kwc">Exception</span><span class="hl opt">):</span>
    <span class="hl str">&quot;&quot;&quot;</span>
<span class="hl str">    Exception raised when an *expected* exception is *not* raised during a</span>
<span class="hl str">    unit test.</span>
<span class="hl str">    &quot;&quot;&quot;</span>
    msg <span class="hl opt">=</span> <span class="hl str">'expected</span> <span class="hl ipl">%s</span><span class="hl str">'</span>

    <span class="hl kwa">def</span> <span class="hl kwd">__init__</span><span class="hl opt">(</span>self<span class="hl opt">,</span> expected<span class="hl opt">):</span>
        self<span class="hl opt">.</span>expected <span class="hl opt">=</span> expected

    <span class="hl kwa">def</span> <span class="hl kwd">__str__</span><span class="hl opt">(</span>self<span class="hl opt">):</span>
        <span class="hl kwa">return</span> self<span class="hl opt">.</span>msg % self<span class="hl opt">.</span>expected<span class="hl opt">.</span>__name__


<span class="hl kwa">def</span> <span class="hl kwd">assert_equal</span><span class="hl opt">(</span>val1<span class="hl opt">,</span> val2<span class="hl opt">):</span>
    <span class="hl str">&quot;&quot;&quot;</span>
<span class="hl str">    Assert ``val1`` and ``val2`` are the same type and of equal value.</span>
<span class="hl str">    &quot;&quot;&quot;</span>
    <span class="hl kwa">assert</span> <span class="hl kwb">type</span><span class="hl opt">(</span>val1<span class="hl opt">)</span> <span class="hl kwa">is</span> <span class="hl kwb">type</span><span class="hl opt">(</span>val2<span class="hl opt">),</span> <span class="hl str">'</span><span class="hl ipl">%r </span><span class="hl str">!=</span> <span class="hl ipl">%r</span><span class="hl str">'</span> % <span class="hl opt">(</span>val1<span class="hl opt">,</span> val2<span class="hl opt">)</span>
    <span class="hl kwa">assert</span> val1 <span class="hl opt">==</span> val2<span class="hl opt">,</span> <span class="hl str">'</span><span class="hl ipl">%r </span><span class="hl str">!=</span> <span class="hl ipl">%r</span><span class="hl str">'</span> % <span class="hl opt">(</span>val1<span class="hl opt">,</span> val2<span class="hl opt">)</span>


<span class="hl kwa">def</span> <span class="hl kwd">assert_not_equal</span><span class="hl opt">(</span>val1<span class="hl opt">,</span> val2<span class="hl opt">):</span>
    <span class="hl str">&quot;&quot;&quot;</span>
<span class="hl str">    Assert ``val1`` and ``val2`` are the same type and of non-equal value.