Package edu.uiuc.ncsa.myproxy.oauth2.tools

Class OA2CLCCommands

  • All Implemented Interfaces:
    edu.uiuc.ncsa.security.core.Logable, edu.uiuc.ncsa.security.util.cli.Commands
    public class OA2CLCCommands
extends edu.uiuc.ncsa.security.util.cli.CommonCommands
    A command line client. Invoke help as needed, but the basic operation is to create the initial request url using the uri(InputLine) call, paste it in your browser, authenticate (since this is an OIDC client, you must pass through a browser at some point). The call back should fail, so you copy the attempted callback from the service using the grant(InputLine) call. You can then do whatever you needed (get an access token, get refresh tokens if the server supports it) inspect id tokens and such.

    Created by Jeff Gaynor
    on 5/11/16 at 2:57 PM

    • Field Detail

      • ce

        protected edu.uiuc.ncsa.oa4mp.oauth2.client.OA2ClientEnvironment ce

      • service

        protected edu.uiuc.ncsa.oa4mp.oauth2.client.OA2MPService service

      • NO_VERIFY_GRANT_FLAG

        public static String NO_VERIFY_GRANT_FLAG
        This is a specific flag for use in proxying only. It turns off the verification that the callback uri is the correct one. The reason is that proxies might have to go through a few forwards etc and there is no way to recover what the original URI was in Tomcat -- it would have to be reconstructed. Therefore, turn off checking this. It is not listed in help and is not normally a user-facing feature.

      • CLEAR_PARAMETERS_FLAG

        public static String CLEAR_PARAMETERS_FLAG

      • ASSET_KEY

        protected String ASSET_KEY

      • AT_RESPONSE_KEY

        protected String AT_RESPONSE_KEY

      • AUTHZ_GRANT_KEY

        protected String AUTHZ_GRANT_KEY

      • AUTHZ_PARAMETERS_KEY

        protected String AUTHZ_PARAMETERS_KEY

      • IS_ERSATZ_KEY

        protected String IS_ERSATZ_KEY
        Used if the client ID was used with another stored configuration to do a fork.

      • CLAIMS_KEY

        public String CLAIMS_KEY

      • CONFIG_NAME_KEY

        protected String CONFIG_NAME_KEY

      • CONFIG_FILE_KEY

        protected String CONFIG_FILE_KEY

      • CURRENT_URI_KEY

        protected String CURRENT_URI_KEY

      • DF_RESPONSE_KEY

        protected String DF_RESPONSE_KEY

      • EXCHANGE_PARAMETERS_KEY

        protected String EXCHANGE_PARAMETERS_KEY

      • INTROSPECT_RESPONSE_KEY

        protected String INTROSPECT_RESPONSE_KEY

      • PRINT_OUTPUT_ON_KEY

        protected String PRINT_OUTPUT_ON_KEY

      • REFRESH_PARAMETERS_KEY

        protected String REFRESH_PARAMETERS_KEY

      • SYSTEM_MESSAGE_KEY

        protected String SYSTEM_MESSAGE_KEY

      • TOKEN_PARAMETERS_KEY

        protected String TOKEN_PARAMETERS_KEY

      • USER_MESSAGE_KEY

        protected String USER_MESSAGE_KEY

      • VERBOSE_ON_KEY

        protected String VERBOSE_ON_KEY

      • PROVISION_ONLY_FLAG

        public static String PROVISION_ONLY_FLAG

      • PROVISION_ONLY_SHORT_FLAG

        public static String PROVISION_ONLY_SHORT_FLAG

      • USERNAME_FLAG

        public String USERNAME_FLAG

      • ALT_USERNAME_FLAG

        public String ALT_USERNAME_FLAG

    • Constructor Detail

      • OA2CLCCommands

        public OA2CLCCommands​(boolean silentMode,
                      edu.uiuc.ncsa.security.core.util.MyLoggingFacade logger,
                      OA2CommandLineClient oa2CommandLineClient)
               throws Throwable
        Throws:
        Throwable

    • Method Detail

      • getPrompt

        public String getPrompt()

      • getCe

        public edu.uiuc.ncsa.oa4mp.oauth2.client.OA2ClientEnvironment getCe()

      • setCe

        public void setCe​(edu.uiuc.ncsa.oa4mp.oauth2.client.OA2ClientEnvironment ce)

      • bootstrap

        public void bootstrap()
               throws Throwable
        Specified by:
        bootstrap in interface edu.uiuc.ncsa.security.util.cli.Commands
        Overrides:
        bootstrap in class edu.uiuc.ncsa.security.util.cli.CommonCommands
        Throws:
        Throwable

      • getHelpUtil

        public edu.uiuc.ncsa.security.util.cli.HelpUtil getHelpUtil()
        Specified by:
        getHelpUtil in interface edu.uiuc.ncsa.security.util.cli.Commands
        Overrides:
        getHelpUtil in class edu.uiuc.ncsa.security.util.cli.CommonCommands

      • getDebugger

        public edu.uiuc.ncsa.security.core.util.MetaDebugUtil getDebugger()
                                                           throws Exception
        Throws:
        Exception

      • setDebugUtil

        public void setDebugUtil​(edu.uiuc.ncsa.security.core.util.MetaDebugUtil metaDebugUtil)
        Use this to explicitly override the debugger in the environment. This is needed if, e.g. QDL is running this as a utility and you want o have the same debugger.
        Parameters:
        metaDebugUtil -

      • bootMessage

        public void bootMessage()

      • getService

        public edu.uiuc.ncsa.oa4mp.oauth2.client.OA2MPService getService()

      • getConfigFile

        public String getConfigFile()

      • setConfigFile

        public void setConfigFile​(String configFile)

      • getURIHelp

        public void getURIHelp()

      • getRandomString

        protected String getRandomString()

      • load

        public void load​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
          throws Throwable
        Throws:
        Throwable

      • df

        public void df​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
        throws Exception
        Throws:
        Exception

      • getDfInterval

        public long getDfInterval()

      • getDfExpiresIn

        public long getDfExpiresIn()

      • getDfResponse

        public net.sf.json.JSONObject getDfResponse()

      • getUserCode

        public String getUserCode()

      • getDeviceCode

        public String getDeviceCode()

      • getCurrentURI

        public URI getCurrentURI()

      • uri

        public void uri​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
         throws Exception
        Constructs the URI
        Parameters:
        inputLine -
        Throws:
        Exception

      • isUseClipboard

        public boolean isUseClipboard()

      • setUseClipboard

        public void setUseClipboard​(boolean useClipboard)

      • copyToClipboard

        protected void copyToClipboard​(String target,
                               String s)

      • echo_http_request

        public void echo_http_request​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                       throws Exception
        Throws:
        Exception

      • echo_http_response

        public void echo_http_response​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                        throws Exception
        Throws:
        Exception

      • getFromClipboard

        protected String getFromClipboard​(boolean silentMode)

      • hasClipboard

        protected boolean hasClipboard()
        Peeks into clipboard to see if it is there and actually works. This is far from a perfect test since it only looks for a string in the clipboard, but actually testing every case for a supported flavor would be much more of a task.
        Returns:

      • printGrant

        protected void printGrant()

      • grant

        public void grant​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
           throws Exception
        Throws:
        Exception

      • getDummyAsset

        public edu.uiuc.ncsa.oa4mp.oauth2.client.OA2Asset getDummyAsset()

      • clear

        public void clear​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine,
                  boolean clearParams)
           throws Exception
        Throws:
        Exception

      • clear

        public void clear​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
           throws Exception
        Throws:
        Exception

      • getClearHelp

        protected void getClearHelp()

      • saveCertHelp

        protected void saveCertHelp()

      • save_cert

        public void save_cert​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
               throws Exception
        If the state supports this, it will save the current cert to a file. The complete filename must be supplied, including any path.
        Parameters:
        inputLine -
        Throws:
        Exception

      • getX509CertificateString

        public String getX509CertificateString()
        Return the certificate(s) as a single PEM-encoded string.
        Returns:

      • hasX509Certificates

        public boolean hasX509Certificates()

      • showRawTokenHelp

        protected void showRawTokenHelp()

      • show_raw_id_token

        public void show_raw_id_token​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                       throws Exception
        Throws:
        Exception

      • setIDToken

        public void setIDToken​(IDTokenImpl idToken)

      • claims

        public void claims​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
            throws Exception
        Throws:
        Exception

      • showClaimsHelp

        protected void showClaimsHelp()

      • showRevokeHelp

        protected void showRevokeHelp()

      • revoke

        public void revoke​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
            throws Exception
        Throws:
        Exception

      • showIntrospectHelp

        protected void showIntrospectHelp()

      • introspect

        public void introspect​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                throws Exception
        Throws:
        Exception

      • getIntrospectResponse

        public net.sf.json.JSONObject getIntrospectResponse()

      • asset

        public void asset​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
           throws Exception
        Throws:
        Exception

      • access

        public void access​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
            throws Exception
        Throws:
        Exception

      • getLastException

        public Throwable getLastException()

      • setLastException

        public void setLastException​(Throwable lastException)

      • hadException

        public boolean hadException()

      • getCertHelp

        protected void getCertHelp()

      • getUIHelp

        protected void getUIHelp()

      • user_info

        public void user_info​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
               throws Exception
        Throws:
        Exception

      • user_info2

        public UserInfo user_info2​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                    throws Exception
        Throws:
        Exception

      • get_cert

        public void get_cert​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
              throws Exception
        Throws:
        Exception

      • getRTHelp

        protected void getRTHelp()

      • resolveFromToken

        public net.sf.json.JSONObject resolveFromToken​(Token token,
                                               boolean noVerify)
        Turns a token into a JSONObject if it is a JWT. Otherwise, it returns a null.
        Parameters:
        token -
        noVerify -
        Returns:

      • validateJWT

        public boolean validateJWT​(String rawToken)

      • authz

        public void authz​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
           throws Exception
        Throws:
        Exception

      • tokens

        public void tokens​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
            throws Exception
        Throws:
        Exception

      • printToken

        public void printToken​(TokenImpl accessToken,
                       boolean noVerify,
                       boolean printRaw)

      • OLDprintToken

        protected void OLDprintToken​(AccessTokenImpl accessToken,
                             boolean noVerify,
                             boolean printRaw)

      • NEWprintToken

        protected void NEWprintToken​(TokenImpl tokenImpl,
                             boolean noVerify,
                             boolean printRaw)

      • OLDprintToken

        protected void OLDprintToken​(RefreshTokenImpl refreshToken,
                             boolean noVerify,
                             boolean printRaw)

      • printTokens

        protected void printTokens​(boolean noVerify,
                           boolean printRaw)

      • refresh

        public void refresh​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
             throws Exception
        Throws:
        Exception

      • getATHelp

        protected void getATHelp()

      • setGrantHelp

        protected void setGrantHelp()

      • exchangeHelp

        protected void exchangeHelp()

      • exchange

        public void exchange​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
              throws Exception
        Throws:
        Exception

      • fromJSON

        public void fromJSON​(net.sf.json.JSONObject json)
              throws Throwable
        Throws:
        Throwable

      • fromJSON

        protected void fromJSON​(net.sf.json.JSONObject json,
                        boolean loadStoredConfig)
                 throws Throwable
        Throws:
        Throwable

      • isErsatz

        public boolean isErsatz()

      • setErsatz

        public void setErsatz​(boolean ersatz)

      • read

        public void read​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
          throws Throwable
        Throws:
        Throwable

      • toJSON

        public net.sf.json.JSONObject toJSON()

      • write

        public void write​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
           throws Exception
        Throws:
        Exception

      • setRequestParameters

        public void setRequestParameters​(HashMap<String,​String> requestParameters)

      • setTokenParameters

        public void setTokenParameters​(HashMap<String,​String> tokenParameters)

      • setRefreshParameters

        public void setRefreshParameters​(HashMap<String,​String> refreshParameters)

      • setExchangeParameters

        public void setExchangeParameters​(HashMap<String,​String> exchangeParameters)

      • set_param

        public void set_param​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
               throws Exception
        Throws:
        Exception

      • get_param

        public void get_param​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
               throws Exception
        Throws:
        Exception

      • clear_all_params

        public void clear_all_params​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
                      throws Exception
        Throws:
        Exception

      • rm_param

        public void rm_param​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
              throws Exception
        Throws:
        Exception

      • rfc7523

        public void rfc7523​(edu.uiuc.ncsa.security.util.cli.InputLine inputLine)
             throws Exception
        Throws:
        Exception