{"id":34657,"date":"2016-05-23T15:23:45","date_gmt":"2016-05-23T09:53:45","guid":{"rendered":"http:\/\/www.tothenew.com\/blog\/?p=34657"},"modified":"2016-05-25T11:36:15","modified_gmt":"2016-05-25T06:06:15","slug":"authorizing-creationentrance-of-a-conference-in-jitsi","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/authorizing-creationentrance-of-a-conference-in-jitsi\/","title":{"rendered":"Authorizing Creation\/Entrance of a Conference in Jitsi"},"content":{"rendered":"

In this blog, we are going to discuss how we can provide authorization for creating or entering a room in Jitsi. While using Jitsi at organisation level there must be some security so that conferences are created or entered after an authorization. <\/span><\/span><\/p>\n

About Jitsi :<\/b><\/span><\/p>\n

Jitsi is a free & open source video conferencing application which allow user to create there room and other user can enter the room with hitting same url with same room name.<\/span><\/span><\/span><\/p>\n

Jitsi consist of different module like <\/span><\/span><\/span><\/p>\n

Lib-jitsi-meet: The Module works on mainly UI part of Jitsi.<\/span><\/span><\/span><\/p>\n

Jicofo(<\/span><\/span><\/span>Ji<\/b><\/span><\/span><\/span>tsi <\/span><\/span><\/span>Co<\/b><\/span><\/span><\/span>nference <\/span><\/span><\/span>Fo<\/b><\/span><\/span><\/span>cus) : The Module Works on Mainly Room & Member Management in Jitsi <\/span><\/span><\/span><\/p>\n

JVB(J<\/strong>itsi-V<\/strong>ideob<\/strong>ridge: The Module Works on relaying the video in conferences.<\/span><\/span><\/span><\/p>\n

Jicoco(<\/span><\/span><\/span>Ji<\/b><\/span><\/span><\/span>tsi <\/span><\/span><\/span>Co<\/b><\/span><\/span><\/span>mmon <\/span><\/span><\/span>Co<\/b><\/span><\/span><\/span>mponent): The Module works on common component of Jitsi.<\/span><\/span><\/span><\/p>\n

All Module Work together to make Jitsi working .<\/span><\/span><\/span><\/p>\n

Why authorization is required in Jitsi: <\/b><\/span><\/p>\n

We know that Jitsi is video conferencing application so whenever you create a room in Jitsi other user can only join this room if he\/she has the url of that room. but it may also possible that un-authorized user can hit the same url and join in the same room, to overcome this kind of behaviour we are adding a key in the url to check whether the user accessing the url is an authorized user or user has an access to that room or not ,if user is not a authorized user then they will not be allowed to enter the room till they access url with an authorized key.<\/p>\n

So lets start working on how to add Authorization while entering a room in Jitsi <\/b><\/p>\n

Will be achieving this by prefixing a key to the room name & separating it with “=” .<\/p>\n

For Example<\/p>\n

Url Before Key: http:\/\/Domain\/roomname<\/p>\n

Url After Key: http:\/\/Domain\/key=roomname<\/p>\n

\"Jitsi-homePage\"

Where admin123 is key & TTND is roomName.<\/p><\/div>\n

Step 1 :<\/b>Let’s find out where the call is going in Jitsi when you enter room name in Jitsi homepage & click “Go” Button with help of which you can create\/enter a room.<\/p>\n

So when you hit “Go” Button the Call is internally going to one of the module of Jitsi that is “lib-jitsi-meet” and create a XMPP Packet(org.xmpp.packet.IQ) and send it to JICOFO.<\/p>\n

In “lib-jitsi-meet” we have a JS File named as moderator.js at \/lib-jitsi-meet\/modules\/xmpp\/moderator.js which has a function called moderator which has one parameter named roomName,so this roomName is what we have given in text area on home page.<\/p>\n

Now In this roomName, Key is attached to it so we can split on “=” and get the key from the room name. Once we get the key in moderator function we can add that key in property map which will be send to JICOFO in the form of XMPP Packet(org.xmpp.packet.IQ) & if Client Key is Not Passed it will prompt an alert saying \u201cPlease enter the Client Key & Room Name in the format <clientKey>=<roomName>\u201d<\/span><\/p>\n

\n

[sourcecode language=”java”] function Moderator(roomName, xmpp, emitter, settings, options) {<\/p>\n

if (roomName.split("=").length == 2) {
\n var clientKey = roomName.split("=")[0];
\n this.roomName = roomName;
\n this.clientKey = clientKey;
\n this.xmppService = xmpp;
\n this.getNextTimeout = createExpBackoffTimer(1000);
\n this.getNextErrorTimeout = createExpBackoffTimer(1000);
\n \/\/ External authentication stuff
\n this.externalAuthEnabled = false;
\n this.settings = settings;
\n this.options = options;<\/p>\n

\/\/ Sip gateway can be enabled by configuring Jigasi host in config.js or
\n \/\/ it will be enabled automatically if focus detects the component through
\n \/\/ service discovery.
\n this.sipGatewayEnabled = this.options.connection.hosts & amp; & amp;
\n this.options.connection.hosts.call_control !== undefined;<\/p>\n

this.eventEmitter = emitter;<\/p>\n

this.connection = this.xmppService.connection;
\n this.focusUserJid;
\n \/\/FIXME:
\n \/\/ Message listener that talks to POPUP window
\n function listener(event) {
\n if (event.data & amp; & amp; event.data.sessionId) {
\n if (event.origin !== window.location.origin) {
\n logger.warn("Ignoring sessionId from different origin: " +
\n event.origin);
\n return;
\n }
\n settings.setSessionId(event.data.sessionId);
\n \/\/ After popup is closed we will authenticate
\n }
\n }
\n \/\/ Register
\n if (window.addEventListener) {
\n window.addEventListener("message", listener, false);
\n } else {
\n window.attachEvent("onmessage", listener);
\n }
\n } else {
\n alert(‘Please enter the Client Key &amp; Room Name in the format <clientKey>=<roomName>’);
\n }
\n}
\n[\/sourcecode]<\/p>\n<\/div>\n

Step 2: <\/b>Lets add a Key in property Map,<\/p>\n

To add a key in Property Map we have to do the changes in createConferenceIq function in moderator.js , In the propertyMap we are adding a property named clientKey.<\/p>\n

\n

[sourcecode language=”java”]
\nModerator.prototype.createConferenceIq = function () {<\/p>\n

\/\/ Generate create conference IQ<\/p>\n

var elem = $iq({to: this.getFocusComponent(), type: ‘set’});<\/p>\n

\/\/ Session Id used for authentication<\/p>\n

var sessionId = this.settings.getSessionId();<\/p>\n

var machineUID = this.settings.getUserId();<\/p>\n

logger.info(<\/p>\n

"Session ID: " + sessionId + " machine UID: " + machineUID);<\/p>\n

elem.c(‘conference’, {<\/p>\n

xmlns: ‘http:\/\/jitsi.org\/protocol\/focus’,<\/p>\n

room: this.roomName,<\/p>\n

‘machine-uid’: machineUID<\/p>\n

});<\/p>\n

if (sessionId) {<\/p>\n

elem.attrs({ ‘session-id’: sessionId});<\/p>\n

}<\/p>\n

if (this.options.connection.hosts !== undefined<\/p>\n

&& this.options.connection.hosts.bridge !== undefined) {<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘bridge’,<\/p>\n

value: this.options.connection.hosts.bridge<\/p>\n

}).up();<\/p>\n

}<\/p>\n

if (this.options.connection.enforcedBridge !== undefined) {<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘enforcedBridge’,<\/p>\n

value: this.options.connection.enforcedBridge<\/p>\n

}).up();<\/p>\n

}<\/p>\n

\/\/ Tell the focus we have Jigasi configured<\/p>\n

if (this.options.connection.hosts !== undefined &&<\/p>\n

this.options.connection.hosts.call_control !== undefined) {<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘call_control’,<\/p>\n

value: this.options.connection.hosts.call_control<\/p>\n

}).up();<\/p>\n

}<\/p>\n

if (this.options.conference.channelLastN !== undefined) {<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘channelLastN’,<\/p>\n

value: this.options.conference.channelLastN<\/p>\n

}).up();<\/p>\n

}<\/p>\n

if (this.options.conference.adaptiveLastN !== undefined) {<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘adaptiveLastN’,<\/p>\n

value: this.options.conference.adaptiveLastN<\/p>\n

}).up();<\/p>\n

}<\/p>\n

if (this.options.conference.disableAdaptiveSimulcast !== undefined ||<\/p>\n

this.options.conference.disableSimulcast) {<\/p>\n

\/\/ disableSimulcast implies disableAdaptiveSimulcast.<\/p>\n

var value = this.options.conference.disableSimulcast ? true :<\/p>\n

this.options.conference.disableAdaptiveSimulcast;<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘disableAdaptiveSimulcast’,<\/p>\n

value: value<\/p>\n

}).up();<\/p>\n

}<\/p>\n

\/\/ TODO: re-enable once rtx is stable<\/p>\n

\/\/if (this.options.conference.disableRtx !== undefined) {<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘disableRtx’,<\/p>\n

\/\/value: this.options.conference.disableRtx<\/p>\n

value: true<\/p>\n

}).up();<\/p>\n

\/\/}<\/p>\n

if (this.options.conference.openSctp !== undefined) {<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘openSctp’,<\/p>\n

value: this.options.conference.openSctp<\/p>\n

}).up();<\/p>\n

}<\/p>\n

if (this.options.conference.startAudioMuted !== undefined)<\/p>\n

{<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘startAudioMuted’,<\/p>\n

value: this.options.conference.startAudioMuted<\/p>\n

}).up();<\/p>\n

}<\/p>\n

if (this.options.conference.startVideoMuted !== undefined)<\/p>\n

{<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘startVideoMuted’,<\/p>\n

value: this.options.conference.startVideoMuted<\/p>\n

}).up();<\/p>\n

}<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘simulcastMode’,<\/p>\n

value: ‘rewriting’<\/p>\n

}).up();<\/p>\n

\/\/elem.up();<\/p>\n

elem.c(<\/p>\n

‘property’, {<\/p>\n

name: ‘clientKey’,<\/p>\n

value: this.clientKey<\/p>\n

}).up();<\/p>\n

elem.up();<\/p>\n

return elem;<\/p>\n

};<\/p>\n

[\/sourcecode]<\/p>\n<\/div>\n

After “lib-jitsi-meet” call goes to “JICOFO” module, In Jicofo we have a Function handleIQSet() in FocusComponent class where the call comes to Jicofo Which Handles an XMPP Packet(org.xmpp.packet.IQ) which represents a request & returns an XMPP Packet(org.xmpp.packet.IQ) which represents the response to the specified request.<\/p>\n

Step 3:\u00a0<\/b>Let’s create a property file on the server which will be having Client Key & Client Name in this format ClientKey=ClientName .<\/p>\n

I am creating the file at this location \/root\/Jitsi\/Keys\/ClientKeys.properties<\/span><\/span><\/p>\n

\n

[sourcecode language=”java”]
\n# Client Key & Client Names<\/p>\n

# Example<\/p>\n

# client name = client key<\/p>\n

admin123=admin
\n[\/sourcecode]<\/p>\n<\/div>\n

Step 4 :\u00a0<\/b>Let’s retrive the authorization Key from the XMPP Packet(org.xmpp.packet.IQ) which is coming as request in handleIQSet() function of focusComponent class of JICOFO & Restrict the user to create\/enter room if it is not authorized key .<\/p>\n

Now in handleIQset() when we get packet as instanceof ConferenceIq then from this ConferenceIq we can fetch the map & clientKey.<\/p>\n

String clientKey = conferenceIq.getPropertiesMap().get(“clientKey”);<\/p>\n

if Client key is empty then error is thrown saying “Client Name \/ Client Key is not Supplied. Please Retry”<\/span>.<\/p>\n

if Client key is not empty then will match client key with the keys in property file on the server.<\/p>\n

if Client Key matches the Key in Property file then will allow him\/her to create\/join the room.<\/p>\n

if Client Key is not matched he will not be allowed to create\/join room and thrown a error saying “Client Name \/ Client Key pair mismatch. Please Retry”<\/span> .<\/p>\n

\n

[sourcecode language=”java”]
\n@Override
\n\tpublic IQ handleIQSet(IQ iq) throws Exception {
\n\t\ttry {
\n\t\t\torg.jivesoftware.smack.packet.IQ smackIq = IQUtils.convert(iq);
\n\t\t\tString client = null;
\n\t\t\tif (smackIq instanceof ConferenceIq) {<\/p>\n

\t\t\t\tConferenceIq conferenceIq = (ConferenceIq) smackIq;
\n\t\t\t\tString clientKey = conferenceIq.getPropertiesMap().get("clientKey");<\/p>\n

\t\t\t\tif (clientKey != null && !clientKey.isEmpty()) {<\/p>\n

\t\t\t\t\tProperties prop = new Properties();
\n\t\t\t\t\tString propFileName ="\/root\/Jitsi\/Keys\/ClientKeys.properties";<\/p>\n

\t\t\t\t\tInputStream inputStream = new FileInputStream(propFileName);<\/p>\n

\t\t\t\t\tif (inputStream != null) {
\n\t\t\t\t\t\tprop.load(inputStream);
\n\t\t\t\t\t}<\/p>\n

\t\t\t\t\tif (prop.isEmpty()) {
\n\t\t\t\t\t\tthrow new FileNotFoundException(
\n\t\t\t\t\t\t\t\t"property file ‘" + propFileName + "’ does not contain any keys");
\n\t\t\t\t\t}
\n\t\t\t\t\tclient = prop.getProperty(clientKey);<\/p>\n

\t\t\t\t\tif (client != null && !client.isEmpty()) {<\/p>\n

\t\t\t\t\t\tClientAttributes clientAttributes = makeClientObject(client);<\/p>\n

\t\t\t\t\t\tif(clientAttributes != null){
\n\t\t\t\t\t\t\tboolean roomExists = focusManager.getConference(conferenceIq.getRoom()) != null;<\/p>\n

\t\t\t\t\t\t\tif (!roomExists && authAuthority != null) {
\n\t\t\t\t\t\t\t\tMap<String, String> propertyMap = conferenceIq.getPropertiesMap();
\n\t\t\t\t\t\t\t\tclientAttributes.setMachineUID(conferenceIq.getMachineUID());
\n\t\t\t\t\t\t\t\tclientAttributes.setClientKey(clientKey);
\n\t\t\t\t\t\t\t\tclientAttributes.setRoomName(conferenceIq.getRoom());
\n\t\t\t\t\t\t\t\tString sessionId = clientAuthenticationImpl.authenticateUser(clientAttributes, propertyMap);<\/p>\n

\t\t\t\t\t\t\t\tconferenceIq.setSessionId(sessionId);
\n\t\t\t\t\t\t\t}
\n\t\t\t\t\t\t}<\/p>\n

\t\t\t\t\t} else {
\n\t\t\t\t\t\tthrow new ClientKeyException("Client Name \/ Client Key pair mismatch. Please Retry");
\n\t\t\t\t\t}
\n\t\t\t\t} else {
\n\t\t\t\t\tthrow new ClientKeyException("Client Name \/ Client Key is not Supplied. Please Retry");
\n\t\t\t\t}<\/p>\n

\t\t\t\torg.jivesoftware.smack.packet.IQ response = handleConferenceIq((ConferenceIq) smackIq);<\/p>\n

\t\t\t\treturn response != null ? IQUtils.convert(response) : null;<\/p>\n

\t\t\t} else if (smackIq instanceof ShutdownIQ) {
\n\t\t\t\tShutdownIQ gracefulShutdownIQ = (ShutdownIQ) smackIq;<\/p>\n

\t\t\t\tif (!gracefulShutdownIQ.isGracefulShutdown()) {
\n\t\t\t\t\treturn IQUtils.convert(org.jivesoftware.smack.packet.IQ.createErrorResponse(smackIq,
\n\t\t\t\t\t\t\tnew XMPPError(XMPPError.Condition.bad_request)));
\n\t\t\t\t}<\/p>\n

\t\t\t\tString from = gracefulShutdownIQ.getFrom();
\n\t\t\t\tString bareFrom = org.jivesoftware.smack.util.StringUtils.parseBareAddress(from);<\/p>\n

\t\t\t\tif (StringUtils.isNullOrEmpty(shutdownAllowedJid) || !shutdownAllowedJid.equals(bareFrom)) {
\n\t\t\t\t\t\/\/ Forbidden
\n\t\t\t\t\tXMPPError forbiddenError = new XMPPError(XMPPError.Condition.forbidden);<\/p>\n

\t\t\t\t\tlogger.warn("Client : " + client + "Rejected shutdown request from: " + from);<\/p>\n

\t\t\t\t\treturn IQUtils
\n\t\t\t\t\t\t\t.convert(org.jivesoftware.smack.packet.IQ.createErrorResponse(smackIq, forbiddenError));
\n\t\t\t\t}<\/p>\n

\t\t\t\tlogger.info("Client : " + client + "Accepted shutdown request from: " + from);<\/p>\n

\t\t\t\tfocusManager.enableGracefulShutdownMode();<\/p>\n

\t\t\t\treturn IQUtils.convert(org.jivesoftware.smack.packet.IQ.createResultIQ(smackIq));
\n\t\t\t} else if (smackIq instanceof LogoutIq) {
\n\t\t\t\tlogger.info("Client : " + client + "Logout IQ received: " + iq.toXML());<\/p>\n

\t\t\t\tif (authAuthority == null) {
\n\t\t\t\t\treturn null;
\n\t\t\t\t}<\/p>\n

\t\t\t\torg.jivesoftware.smack.packet.IQ smackResult = authAuthority.processLogoutIq((LogoutIq) smackIq);<\/p>\n

\t\t\t\treturn smackResult != null ? IQUtils.convert(smackResult) : null;
\n\t\t\t} else {
\n\t\t\t\treturn super.handleIQSet(iq);
\n\t\t\t}<\/p>\n

\t\t} catch (Exception e) {
\n\t\t\tlogger.error(e, e);
\n\t\t\tthrow e;
\n\t\t}
\n\t}
\n[\/sourcecode]<\/p>\n<\/div>\n

Thank You, Hope you liked it .<\/p>\n

Keep Jitsing , Cheers !!!<\/p>\n","protected":false},"excerpt":{"rendered":"

In this blog, we are going to discuss how we can provide authorization for creating or entering a room in Jitsi. While using Jitsi at organisation level there must be some security so that conferences are created or entered after an authorization. About Jitsi : Jitsi is a free & open source video conferencing application […]<\/p>\n","protected":false},"author":923,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":42},"categories":[1],"tags":[3358,3357,3369,3368,3370,3371,3359,3367,3366],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/34657"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/923"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=34657"}],"version-history":[{"count":0,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/34657\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=34657"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=34657"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=34657"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}