LocalComponentSession.java 16.7 KB
Newer Older
Gaston Dombiak's avatar
Gaston Dombiak committed
1 2 3 4 5
/**
 * $RCSfile: $
 * $Revision: $
 * $Date: $
 *
6
 * Copyright (C) 2005-2008 Jive Software. All rights reserved.
Gaston Dombiak's avatar
Gaston Dombiak committed
7
 *
8 9 10 11 12 13 14 15 16 17 18
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
Gaston Dombiak's avatar
Gaston Dombiak committed
19 20 21
 */
package org.jivesoftware.openfire.session;

22 23 24 25 26 27
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

Gaston Dombiak's avatar
Gaston Dombiak committed
28 29 30 31 32 33 34 35
import org.jivesoftware.openfire.Connection;
import org.jivesoftware.openfire.PacketException;
import org.jivesoftware.openfire.SessionManager;
import org.jivesoftware.openfire.StreamID;
import org.jivesoftware.openfire.auth.AuthFactory;
import org.jivesoftware.openfire.component.ExternalComponentManager;
import org.jivesoftware.openfire.component.InternalComponentManager;
import org.jivesoftware.util.LocaleUtils;
36 37
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Gaston Dombiak's avatar
Gaston Dombiak committed
38 39
import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlPullParserException;
40
import org.xmpp.component.ComponentException;
Gaston Dombiak's avatar
Gaston Dombiak committed
41
import org.xmpp.component.ComponentManager;
42
import org.xmpp.packet.IQ;
Gaston Dombiak's avatar
Gaston Dombiak committed
43 44 45 46 47 48 49 50 51 52 53
import org.xmpp.packet.JID;
import org.xmpp.packet.Packet;
import org.xmpp.packet.StreamError;

/**
 * Represents a session between the server and a component.
 *
 * @author Gaston Dombiak
 */
public class LocalComponentSession extends LocalSession implements ComponentSession {

54 55
	private static final Logger Log = LoggerFactory.getLogger(LocalComponentSession.class);

56
    private LocalExternalComponent component;
57 58 59 60 61 62 63
    /**
     * When using XEP-114 (the old spec) components will include in the TO attribute
     * of the intial stream header the domain they would like to have. The requested
     * domain is used only after the authentication was successful so we need keep track
     * of this information until the handshake is done.  
     */
    private String defaultSubdomain;
Gaston Dombiak's avatar
Gaston Dombiak committed
64 65 66 67 68 69 70 71 72

    /**
     * Returns a newly created session between the server and a component. The session will be
     * created and returned only if all the checkings were correct.<p>
     *
     * A domain will be binded for the new connecting component. This method is following
     * the JEP-114 where the domain to bind is sent in the TO attribute of the stream header.
     *
     * @param serverName the name of the server where the session is connecting to.
73
     * @param xpp     the parser that is reading the provided XML through the connection.
Gaston Dombiak's avatar
Gaston Dombiak committed
74 75
     * @param connection the connection with the component.
     * @return a newly created session between the server and a component.
76
     * @throws XmlPullParserException if there was an XML error while creating the session.
Gaston Dombiak's avatar
Gaston Dombiak committed
77
     */
78 79
    public static LocalComponentSession createSession(String serverName, XmlPullParser xpp, Connection connection)
            throws XmlPullParserException {
Gaston Dombiak's avatar
Gaston Dombiak committed
80
        String domain = xpp.getAttributeValue("", "to");
81
        Boolean allowMultiple = xpp.getAttributeValue("", "allowMultiple") != null;
Gaston Dombiak's avatar
Gaston Dombiak committed
82

83 84
        Log.debug("LocalComponentSession: [ExComp] Starting registration of new external component for domain: " +
                domain);
Gaston Dombiak's avatar
Gaston Dombiak committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98

        // Default answer header in case of an error
        StringBuilder sb = new StringBuilder();
        sb.append("<?xml version='1.0' encoding='");
        sb.append(CHARSET);
        sb.append("'?>");
        sb.append("<stream:stream ");
        sb.append("xmlns:stream=\"http://etherx.jabber.org/streams\" ");
        sb.append("xmlns=\"jabber:component:accept\" from=\"");
        sb.append(domain);
        sb.append("\">");

        // Check that a domain was provided in the stream header
        if (domain == null) {
99
            Log.debug("LocalComponentSession: [ExComp] Domain not specified in stanza: " + xpp.getText());
Gaston Dombiak's avatar
Gaston Dombiak committed
100 101 102
            // Include the bad-format in the response
            StreamError error = new StreamError(StreamError.Condition.bad_format);
            sb.append(error.toXML());
103
            connection.deliverRawText(sb.toString());
Gaston Dombiak's avatar
Gaston Dombiak committed
104 105 106 107 108 109 110 111 112 113 114
            // Close the underlying connection
            connection.close();
            return null;
        }

        // Get the requested subdomain
        String subdomain = domain;
        int index = domain.indexOf(serverName);
        if (index > -1) {
            subdomain = domain.substring(0, index -1);
        }
115 116
        domain = subdomain + "." + serverName;
        JID componentJID = new JID(domain);
Gaston Dombiak's avatar
Gaston Dombiak committed
117 118
        // Check that an external component for the specified subdomain may connect to this server
        if (!ExternalComponentManager.canAccess(subdomain)) {
119 120
            Log.debug(
                    "LocalComponentSession: [ExComp] Component is not allowed to connect with subdomain: " + subdomain);
Gaston Dombiak's avatar
Gaston Dombiak committed
121 122
            StreamError error = new StreamError(StreamError.Condition.host_unknown);
            sb.append(error.toXML());
123
            connection.deliverRawText(sb.toString());
Gaston Dombiak's avatar
Gaston Dombiak committed
124 125 126 127 128 129 130
            // Close the underlying connection
            connection.close();
            return null;
        }
        // Check that a secret key was configured in the server
        String secretKey = ExternalComponentManager.getSecretForComponent(subdomain);
        if (secretKey == null) {
131
            Log.debug("LocalComponentSession: [ExComp] A shared secret for the component was not found.");
Gaston Dombiak's avatar
Gaston Dombiak committed
132 133 134
            // Include the internal-server-error in the response
            StreamError error = new StreamError(StreamError.Condition.internal_server_error);
            sb.append(error.toXML());
135
            connection.deliverRawText(sb.toString());
Gaston Dombiak's avatar
Gaston Dombiak committed
136 137 138 139 140
            // Close the underlying connection
            connection.close();
            return null;
        }
        // Check that the requested subdomain is not already in use
141
        if (!allowMultiple && InternalComponentManager.getInstance().hasComponent(componentJID)) {
142
            Log.debug("LocalComponentSession: [ExComp] Another component is already using domain: " + domain);
Gaston Dombiak's avatar
Gaston Dombiak committed
143 144 145 146
            // Domain already occupied so return a conflict error and close the connection
            // Include the conflict error in the response
            StreamError error = new StreamError(StreamError.Condition.conflict);
            sb.append(error.toXML());
147
            connection.deliverRawText(sb.toString());
Gaston Dombiak's avatar
Gaston Dombiak committed
148 149 150 151 152 153
            // Close the underlying connection
            connection.close();
            return null;
        }

        // Create a ComponentSession for the external component
154 155
        LocalComponentSession session = SessionManager.getInstance().createComponentSession(componentJID, connection);
        session.component = new LocalExternalComponent(session, connection);
Gaston Dombiak's avatar
Gaston Dombiak committed
156 157

        try {
158
            Log.debug("LocalComponentSession: [ExComp] Send stream header with ID: " + session.getStreamID() +
Gaston Dombiak's avatar
Gaston Dombiak committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172
                    " for component with domain: " +
                    domain);
            // Build the start packet response
            sb = new StringBuilder();
            sb.append("<?xml version='1.0' encoding='");
            sb.append(CHARSET);
            sb.append("'?>");
            sb.append("<stream:stream ");
            sb.append("xmlns:stream=\"http://etherx.jabber.org/streams\" ");
            sb.append("xmlns=\"jabber:component:accept\" from=\"");
            sb.append(domain);
            sb.append("\" id=\"");
            sb.append(session.getStreamID().toString());
            sb.append("\">");
173 174 175 176 177 178 179
            connection.deliverRawText(sb.toString());

            // Return session although session has not been authentication yet. Until
            // it is authenticated traffic will be rejected except for authentication
            // requests
            session.defaultSubdomain = subdomain;
            return session;
Gaston Dombiak's avatar
Gaston Dombiak committed
180 181 182 183 184 185 186 187 188 189 190 191 192
        }
        catch (Exception e) {
            Log.error("An error occured while creating a ComponentSession", e);
            // Close the underlying connection
            connection.close();
            return null;
        }
    }

    public LocalComponentSession(String serverName, Connection conn, StreamID id) {
        super(serverName, conn, id);
    }

193 194
    @Override
	public String getAvailableStreamFeatures() {
Gaston Dombiak's avatar
Gaston Dombiak committed
195 196 197 198
        // Nothing special to add
        return null;
    }

199 200
    @Override
	boolean canProcess(Packet packet) {
Gaston Dombiak's avatar
Gaston Dombiak committed
201 202 203
        return true;
    }

204 205
    @Override
	void deliver(Packet packet) throws PacketException {
206
        component.deliver(packet);
Gaston Dombiak's avatar
Gaston Dombiak committed
207 208 209 210 211 212
    }

    public ExternalComponent getExternalComponent() {
        return component;
    }

213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
    /**
     * Authenticate the external component using a digest method. The digest includes the
     * stream ID and the secret key of the main domain of the external component. A component
     * needs to authenticate just once but it may bind several domains.
     *
     * @param digest the digest sent in the handshake.
     * @return true if the authentication was successful.
     */
    public boolean authenticate(String digest) {
        // Perform authentication. Wait for the handshake (with the secret key)
        String secretKey = ExternalComponentManager.getSecretForComponent(defaultSubdomain);
        String anticipatedDigest = AuthFactory.createDigest(getStreamID().getID(), secretKey);
        // Check that the provided handshake (secret key + sessionID) is correct
        if (!anticipatedDigest.equalsIgnoreCase(digest)) {
            Log.debug("LocalComponentSession: [ExComp] Incorrect handshake for component with domain: " +
                    defaultSubdomain);
            //  The credentials supplied by the initiator are not valid (answer an error
            // and close the connection)
            conn.deliverRawText(new StreamError(StreamError.Condition.not_authorized).toXML());
            // Close the underlying connection
            conn.close();
            return false;
        }
        else {
            // Component has authenticated fine
            setStatus(STATUS_AUTHENTICATED);
            // Send empty handshake element to acknowledge success
            conn.deliverRawText("<handshake></handshake>");
            // Bind the domain to this component
            ExternalComponent component = getExternalComponent();
            try {
                InternalComponentManager.getInstance().addComponent(defaultSubdomain, component);
                Log.debug(
                        "LocalComponentSession: [ExComp] External component was registered SUCCESSFULLY with domain: " +
                                defaultSubdomain);
                return true;
            }
            catch (ComponentException e) {
                Log.debug("LocalComponentSession: [ExComp] Another component is already using domain: " +
                        defaultSubdomain);
                //  The credentials supplied by the initiator are not valid (answer an error
                // and close the connection)
                conn.deliverRawText(new StreamError(StreamError.Condition.conflict).toXML());
                // Close the underlying connection
                conn.close();
                return false;
            }
        }
    }

Gaston Dombiak's avatar
Gaston Dombiak committed
263 264 265 266 267 268 269 270 271 272 273 274 275
    /**
     * The ExternalComponent acts as a proxy of the remote connected component. Any Packet that is
     * sent to this component will be delivered to the real component on the other side of the
     * connection.<p>
     *
     * An ExternalComponent will be added as a route in the RoutingTable for each connected
     * external component. This implies that when the server receives a packet whose domain matches
     * the external component services address then a route to the external component will be used
     * and the packet will be forwarded to the component on the other side of the connection.
     *
     * @author Gaston Dombiak
     */
    public static class LocalExternalComponent implements ComponentSession.ExternalComponent {
276 277 278 279 280 281
        /**
         * Keeps track of the IQ (get/set) packets that were sent from a given component's connection. This
         * information will be used to ensure that the IQ reply will be sent to the same component's connection.
         */
        private static final Map<String, LocalExternalComponent> iqs = new HashMap<String, LocalExternalComponent>();

282
        private LocalComponentSession session;
Gaston Dombiak's avatar
Gaston Dombiak committed
283 284 285 286 287 288 289 290 291 292 293
        private Connection connection;
        private String name = "";
        private String type = "";
        private String category = "";
        /**
         * List of subdomains that were binded for this component. The list will include
         * the initial subdomain.
         */
        private List<String> subdomains = new ArrayList<String>();


294 295
        public LocalExternalComponent(LocalComponentSession session, Connection connection) {
            this.session = session;
Gaston Dombiak's avatar
Gaston Dombiak committed
296 297 298 299
            this.connection = connection;
        }

        public void processPacket(Packet packet) {
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
            if (packet instanceof IQ) {
                IQ iq = (IQ) packet;
                if (iq.getType() == IQ.Type.result || iq.getType() == IQ.Type.error) {
                    // Check if this IQ reply belongs to a specific component and route
                    // reply to that specific component (if it exists)
                    LocalExternalComponent targetComponent;
                    synchronized (iqs) {
                        targetComponent = iqs.remove(packet.getID());
                    }
                    if (targetComponent != null) {
                        targetComponent.processPacket(packet);
                        return;
                    }
                }
            }
315 316 317 318 319 320 321 322 323 324 325
            // Ask the session to process the outgoing packet. This will
            // give us the chance to apply PacketInterceptors
            session.process(packet);
        }

        /**
         * Delivers the packet to the external component.
         *
         * @param packet the packet to deliver.
         */
        void deliver(Packet packet) {
Gaston Dombiak's avatar
Gaston Dombiak committed
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
            if (connection != null && !connection.isClosed()) {
                try {
                    connection.deliver(packet);
                }
                catch (Exception e) {
                    Log.error(LocaleUtils.getLocalizedString("admin.error"), e);
                    connection.close();
                }
            }
        }

        public String getName() {
            return name;
        }

        public String getDescription() {
            return category + " - " + type;
        }

        public void setName(String name) {
            this.name = name;
        }

        public String getType() {
            return type;
        }

        public void setType(String type) {
            this.type = type;
        }

        public String getCategory() {
            return category;
        }

        public void setCategory(String category) {
            this.category = category;
        }

        public String getInitialSubdomain() {
            if (subdomains.isEmpty()) {
                return null;
            }
            return subdomains.get(0);
        }

        private void addSubdomain(String subdomain) {
            subdomains.add(subdomain);
        }

        public Collection<String> getSubdomains() {
            return subdomains;
        }

        public void initialize(JID jid, ComponentManager componentManager) {
            addSubdomain(jid.toString());
        }

        public void start() {
        }

        public void shutdown() {
388 389 390 391 392 393 394 395 396 397 398 399 400
            // Remove tracking of IQ packets sent from this component
            synchronized (iqs) {
                List<String> toRemove = new ArrayList<String>();
                for (Map.Entry<String,LocalExternalComponent> entry : iqs.entrySet()) {
                    if (entry.getValue() == this) {
                        toRemove.add(entry.getKey());
                    }
                }
                // Remove keys pointing to component being removed
                for (String key : toRemove) {
                    iqs.remove(key);
                }
            }
Gaston Dombiak's avatar
Gaston Dombiak committed
401 402
        }

403 404
        @Override
		public String toString() {
Gaston Dombiak's avatar
Gaston Dombiak committed
405 406
            return super.toString() + " - subdomains: " + subdomains;
        }
407 408 409 410 411 412

        public void track(IQ iq) {
            synchronized (iqs) {
                iqs.put(iq.getID(), this);
            }
        }
Gaston Dombiak's avatar
Gaston Dombiak committed
413 414
    }
}