001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.security.srp;
023:
024: import org.jboss.invocation.Invocation;
025: import org.jboss.system.ServiceMBean;
026:
027: /**
028: * The JMX mbean interface for the SRP service. This mbean sets up an
029: * RMI implementation of the 'Secure Remote Password' cryptographic authentication
030: * system developed by Tom Wu (tjw@CS.Stanford.EDU). For more info on SRP
031: * see http://www-cs-students.stanford.edu/~tjw/srp/.
032: *
033: * @author Scott.Stark@jboss.org
034: * @version $Revision: 57210 $
035: */
036: public interface SRPServiceMBean extends ServiceMBean {
037: /**
038: * Get the jndi name for the SRPVerifierSource implementation binding.
039: */
040: String getVerifierSourceJndiName();
041:
042: /**
043: * set the jndi name for the SRPVerifierSource implementation binding.
044: */
045: void setVerifierSourceJndiName(String jndiName);
046:
047: /**
048: * Get the jndi name under which the SRPServerInterface proxy should be bound
049: */
050: String getJndiName();
051:
052: /**
053: * Set the jndi name under which the SRPServerInterface proxy should be bound
054: */
055: void setJndiName(String jndiName);
056:
057: /**
058: * Get the jndi name under which the SRPServerInterface proxy should be bound
059: */
060: String getAuthenticationCacheJndiName();
061:
062: /**
063: * Set the jndi name under which the SRPServerInterface proxy should be bound
064: */
065: void setAuthenticationCacheJndiName(String jndiName);
066:
067: /**
068: * Get the auth cache timeout period in seconds
069: */
070: int getAuthenticationCacheTimeout();
071:
072: /**
073: * Set the auth cache timeout period in seconds
074: */
075: void setAuthenticationCacheTimeout(int timeoutInSecs);
076:
077: /**
078: * Get the auth cache resolution period in seconds
079: */
080: int getAuthenticationCacheResolution();
081:
082: /**
083: * Set the auth cache resolution period in seconds
084: */
085: void setAuthenticationCacheResolution(int resInSecs);
086:
087: /** Get if the client must supply an auxillary challenge as part of the
088: * verify phase.
089: */
090: public boolean getRequireAuxChallenge();
091:
092: /** Set if the client must supply an auxillary challenge as part of the
093: * verify phase.
094: */
095: public void setRequireAuxChallenge(boolean flag);
096:
097: /** A flag indicating if a successful user auth for an existing session
098: should overwrite the current session.
099: */
100: public boolean getOverwriteSessions();
101:
102: /** Set the flag indicating if a successful user auth for an existing session
103: should overwrite the current session.
104: */
105: public void setOverwriteSessions(boolean flag);
106:
107: /**
108: * Get the RMIClientSocketFactory implementation class. If null the default
109: * RMI client socket factory implementation is used.
110: */
111: String getClientSocketFactory();
112:
113: /**
114: * Set the RMIClientSocketFactory implementation class. If null the default
115: * RMI client socket factory implementation is used.
116: */
117: void setClientSocketFactory(String factoryClassName)
118: throws ClassNotFoundException, InstantiationException,
119: IllegalAccessException;
120:
121: /**
122: * Get the RMIServerSocketFactory implementation class. If null the default
123: * RMI server socket factory implementation is used.
124: */
125: String getServerSocketFactory();
126:
127: /**
128: * Set the RMIServerSocketFactory implementation class. If null the default
129: * RMI server socket factory implementation is used.
130: */
131: void setServerSocketFactory(String factoryClassName)
132: throws ClassNotFoundException, InstantiationException,
133: IllegalAccessException;
134:
135: /**
136: * Get the RMI port for the SRPRemoteServerInterface
137: */
138: int getServerPort();
139:
140: /**
141: * Set the RMI port for the SRPRemoteServerInterface
142: */
143: void setServerPort(int port);
144:
145: /** Expose the Invoker signature via JMX
146: */
147: public Object invoke(Invocation invocation) throws Exception;
148: }
|