cilogon / service-lib

src/Service/MyProxy.php

<?php

namespace CILogon\Service;

use CILogon\Service\Util;

/**
 * MyProxy
 */
class MyProxy
{
    /**
     * getMyProxyCredential
     *
     * This function gets an X.509 credential (as a string) for a user.
     *
     * @param string $username The MyProxy user name (-l)
     * @param string $passphrase (Optional) The MyProxy password for the
     *        username (-S). Defaults to empty string.  NOTE: If $passphrase
     *        is non-empty, you CANNOT set a $certreq.
     * @param string $server (Optional) The MyProxy server to connect to (-s).
     *        Defaults to MYPROXY_HOST.
     * @param int $port (Optional) The port for the MyProxy server (-p).
     *        Defaults to MYPROXY_PORT.
     * @param int $lifetime (Optional) The life of the proxy in hours (-t).
     *        Defaults to MYPROXY_LIFETIME hours.
     * @param string $usercert (Optional) The X509_USER_CERT environment
     *        variable, OR the X509_USER_PROXY environment variable if
     *        $userkey is set to the empty string.  Defaults to empty string.
     * @param string $userkey (Optional) The X509_USER_KEY environment
     *        variable. Defaults to empty string.
     * @param string $certreq (Optional) A certificate request created by the
     *        openssl req command (--certreq).  Defaults to empty string.
     *        NOTE: If $certreq is non-empty, you CANNOT set a $passphrase.
     * @param string $env (Optional) Extra environment variables in the form
     *        of space-separated 'key=value' pairs.
     * @return string An X509 credential in a string upon success, or
     *         an empty string upon failure.
     */
    public static function getMyProxyCredential(
        $username,
        $passphrase = '',
        $server = MYPROXY_HOST,

The constant CILogon\Service\MYPROXY_HOST was not found. Maybe you did not declare it correctly or list all dependencies?

        $port = MYPROXY_PORT,

The constant CILogon\Service\MYPROXY_PORT was not found. Maybe you did not declare it correctly or list all dependencies?

        $lifetime = MYPROXY_LIFETIME,

The constant CILogon\Service\MYPROXY_LIFETIME was not found. Maybe you did not declare it correctly or list all dependencies?

        $usercert = '',
        $userkey = '',
        $certreq = '',
        $env = ''
    ) {
        $retstr = '';

        // Verify the myproxy-logon binary has been configured
        if ((!defined('MYPROXY_LOGON')) || (empty(MYPROXY_LOGON))) {

The constant CILogon\Service\MYPROXY_LOGON was not found. Maybe you did not declare it correctly or list all dependencies?

            Util::sendErrorAlert(
                'getMyProxyCredential Error',
                'MyProxy Error = myproxy-logon binary not configured'
            );
            return $retstr;
        }

        // Make sure the username passed in is not empty
        if (strlen($username) == 0) {
            Util::sendErrorAlert(
                'getMyProxyCredential Error',
                'MyProxy Error = Missing MyProxy username'
            );
            return $retstr;
        }

        // Don't allow weird port numbers, i.e. negative or over 65535
        if (($port < 0) || ($port > 65535)) {
            $port = MYPROXY_PORT;
        }

        // Don't allow weird lifetimes, i.e. negative or over 5 years
        if (($lifetime < 0) || ($lifetime > 43800)) {
            $lifetime = MYPROXY_LIFETIME;
        }

        // If the usercert (X509_USER_CERT) is specified, check to see if
        // the userkey (X509_USER_KEY) was as well.  If not, set userkey to
        // usercert, in effect making usercert act like X509_USER_PROXY. Then,
        // set the USER_CERT_ENV variable to bundle the two parameters into a
        // single variable holding the two X509_USER_* environment variables.
        $USER_CERT_ENV = '';
        if (strlen($usercert) > 0) {
            if (strlen($userkey) == 0) {
                $userkey = $usercert;
            }
            $USER_CERT_ENV = 'X509_USER_CERT=' . escapeshellarg($usercert) .
                             ' ' .
                             'X509_USER_KEY='  . escapeshellarg($userkey);
        }

        // Run the myproxy-logon command and capture the output and any error
        $output = array();
        $cmd = '/bin/env ' .
               $USER_CERT_ENV . ' ' .
               $env . ' ' .
               'MYPROXY_SOCKET_TIMEOUT=1 ' .
               MYPROXY_LOGON . ' ' .
               ' -s ' . escapeshellarg($server) .
               " -p $port" .
               " -t $lifetime" .
               ' -l ' . escapeshellarg($username) .
               ' -S -o -' .
               ((strlen($certreq) > 0) ?
                   (' --certreq - <<< ' . escapeshellarg($certreq)) : '') .
               ((strlen($passphrase) > 0) ?
                   (' <<< ' . escapeshellarg($passphrase)) : ' -n') .
               ' 2>&1';
        exec($cmd, $output, $return_val);
        $retstr = implode("\n", $output);

        if ($return_val > 0) {
            Util::sendErrorAlert(
                'getMyProxyCredential Error',
                "MyProxy Error = $return_val\nMyProxy Output= $retstr"
            );
            $retstr = '';
        }

        return $retstr;
    }

    /**
     * getDefaultLifetime
     *
     * This function returns the value of the class defined
     * MYPROXY_LIFETIME as an int, which may be needed in '/secure/getuser'
     * when getting a certificate.
     *
     * @return int The value of MYPROXY_LIFETIME
     */
    public static function getDefaultLifetime()
    {
        return (int)MYPROXY_LIFETIME;

The constant CILogon\Service\MYPROXY_LIFETIME was not found. Maybe you did not declare it correctly or list all dependencies?

    }
}