Openfire

This is a fork for in-house usage.

For help on the usage of this work in specific, go to the src/plugins/suJoin directory.

Hacking OpenFire

Luckily, since March 31st 2014 they migrated from SVN to GitHub! I made a fork which can be clones with:

git clone https://github.com/straypacket/Openfire.git

or

git clone git@odin.suj.jp:d.pereira/sujopenfire.git

The plugins section, which is what we're omre interested in, are in src/plugins/. The base of our API plug is the directory userservice.

To compile plugins, just compile the whole project with from within the root of the project:

make clean
cd build
ant plugins

Make sure you build the project with the same architecture as the one used in the server (i.e. both are 32 or 64 bit versions).

This process will compile the binary .jar file into ../work/plugins

If the plugin works as expected, push your changes to git.

If you want to create a new plugin, you should copy one of the existing plugins and carefully refactor the names of the classes, packages and URLs. After that, all the above commands should work without any problems.

SUJoin API

To install self-developped plugins, use the webservice upload feature, in Plugins\Upload Plugin to upload the generated .jar file.

Alternatively, and in a less safe manner, copy the .jar file from the previous compilation to the plugins directory from the root openfire directory:

scp -i AWS_KEY.pem work/plugins/suJoin.jar ubuntu@EC2-INSTANCE:openfire/plugins/

To install, unpack the .jar file with:

unzip suJoin.jar

This will install the plugin and you'll be able to see the plugin in action from OpenFire's web interface, at Server/Server Settings. No need to restart the servers.

Usage

To use the plugin, go to the Server/Server Settings/SUJ Join and enable it. Copy the Secret key and use it according to the documentation. A Ruby client that can be adapted makes use of the same API at [2]. For obvious safety reasons, we only support POST requests.

[EXAMPLE] Add user with wget:

wget -S -O - -T 1 -t 1 -nv -q --no-check-certificate --post-data="type=add&secret=secretkey&username=kafka&password=drowssap&name=franz&email=franz@kafka.com" "https://example.com:9091/plugins/suJoin/sujoin"

Reply should be:

HTTP/1.1 200 OK
Set-Cookie: JSESSIONID=kjhgkjguyf;Path=/
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Content-Type: text/xml;charset=UTF-8
Transfer-Encoding: chunked
<result>ok</result>	

You can use any other tool, such as curl.

API Requests

API calls implemented, according to functionality. Take a look at the Usage example, these parameter calls should replace those in above the --post-data example.

Authentication parameters:

• secret=STRING [REQUIRED]

User management parameters:

• type=add

• type=delete

• type=update

• type=enable

• type=disable

User properties:

• username=STRING [REQUIRED for user operations]

• password=STRING [REQUIRED only for user creation]

• name=STRING

• groups=STRING

• email=STRING

Roster management parameters:

• type=add_roster

• type=update_roster

• type=delete_roster

• item_jid=STRING|JID [REQUIRED for roster operations]

API example calls:

User creation

wget -S -O - -T 1 -t 1 -nv -q --no-check-certificate --post-data="type=add_user&secret=pCdk7C26&username=pratchett&password=ankmorpork&usercode=u1&tenantcode=t1&deptcode=d1&groupcode=g1&phone=123123123&pre_register=yes&devices=device1,device2,device3" "https://ec2-54-249-68-201.ap-northeast-1.compute.amazonaws.com:9091/plugins/suJoin/sujoin"

User edition:

wget -S -O - -T 1 -t 1 -nv -q --no-check-certificate --post-data="type=edit_user&secret=pCdk7C26&username=pratchett&password=ankmorpork&usercode=u1&tenantcode=t1&deptcode=d1&groupcode=g1&phone=123123123&pre_register=yes&devices=device1,device2" "https://ec2-54-249-68-201.ap-northeast-1.compute.amazonaws.com:9091/plugins/suJoin/sujoin"

User deletion:

wget -S -O - -T 1 -t 1 -nv -q --no-check-certificate --post-data="type=delete_user&secret=pCdk7C26&username=pratchett" "https://ec2-54-249-68-201.ap-northeast-1.compute.amazonaws.com:9091/plugins/suJoin/sujoin"

Get all users:

wget -S -O - -T 1 -t 1 -nv -q --no-check-certificate --post-data="type=get_all_users&secret=pCdk7C26" "https://ec2-54-249-68-201.ap-northeast-1.compute.amazonaws.com:9091/plugins/suJoin/sujoin"

Search for user:

wget -S -O - -T 1 -t 1 -nv -q --no-check-certificate --post-data="type=search_user&secret=pCdk7C26&username=kafka" "https://ec2-54-249-68-201.ap-northeast-1.compute.amazonaws.com:9091/plugins/suJoin/sujoin"

Add group:

wget -S -O - -T 1 -t 1 -nv -q --no-check-certificate --post-data="type=add_group&secret=pCdk7C26&tenantcode=t1&groupname=the_chat&ownername=pratchett&groupusers=pratchett1,kafka&groupcode=g1" "https://ec2-54-249-68-201.ap-northeast-1.compute.amazonaws.com:9091/plugins/suJoin/sujoin"

Delete group:

wget -S -O - -T 1 -t 1 -nv -q --no-check-certificate --post-data="type=delete_group&secret=pCdk7C26&groupcode=g1" "https://ec2-54-249-68-201.ap-northeast-1.compute.amazonaws.com:9091/plugins/suJoin/sujoin"

Get all groups:

wget -S -O - -T 1 -t 1 -nv -q --no-check-certificate --post-data="type=get_all_groups&secret=pCdk7C26" "https://ec2-54-249-68-201.ap-northeast-1.compute.amazonaws.com:9091/plugins/suJoin/sujoin"

Search for groups:

wget -S -O - -T 1 -t 1 -nv -q --no-check-certificate --post-data="type=delete_group&secret=pCdk7C26&groupcode=g1&tenantcode=t1" "https://ec2-54-249-68-201.ap-northeast-1.compute.amazonaws.com:9091/plugins/suJoin/sujoin"

Add group:

wget -S -O - -T 1 -t 1 -nv -q --no-check-certificate --post-data="type=edit_group&secret=pCdk7C26&tenantcode=t1&groupname=the_chat&ownername=pratchett&groupusers=pratchett1,kafka&groupcode=g1" "https://ec2-54-249-68-201.ap-northeast-1.compute.amazonaws.com:9091/plugins/suJoin/sujoin"

SUJ Message Handler

To install self-developped plugins, use the webservice upload feature, in Plugins\Upload Plugin to upload the generated .jar file.

Alternatively, and in a less safe manner, copy the .jar file from the previous compilation to the plugins directory from the root openfire directory:

    scp -i AWS_KEY.pem work/plugins/sujMessageHandler.jar ubuntu@EC2-INSTANCE:openfire/plugins/

To install, unpack the .jar file with:

    unzip sujMessageHandler.jar

This will install the plugin and you'll be able to see the plugin in action from OpenFire's web interface, at Server/Server Settings. No need to restart the servers.

Extra database tables

In order to have second device checking mechanisms in Openfire, the following table needs to be created in the Openfire database.

Second device table:

CREATE TABLE ofSecondDevice ( 
	secondID VARCHAR(64) NOT NULL, 
	secondPass VARCHAR(256) NOT NULL, 
	jid VARCHAR(256) NOT NULL UNIQUE,
	PRIMARY KEY (secondID) 
);

Field	Type	Null	Key	Default	Extra
secondID	varchar(64)	NO	PRI	NULL
secondPass	varchar(256)	NO		NULL
jid	varchar(256)	NO	UNI	NULL

User tables

User metadata table:

The column user_jid connects with Openfire world.

creation_date, name and email is in the Openfire side.

CREATE TABLE ofUserMetadata (
	user_code VARCHAR(64) NOT NULL,
	group_code VARCHAR(256) NOT NULL,
	tenant_code VARCHAR(64) NOT NULL, 
	user_name VARCHAR(64) NOT NULL, 
	dept_code VARCHAR(64), 
	phone VARCHAR(64),
	pre_register VARCHAR(64),
	joined VARCHAR(64),
	PRIMARY KEY (user_code)
);

Field	Type	Null	Key	Default	Extra
user_code	varchar(64)	NO	PRI	NULL
group_code	varchar(256)	NO		NULL
tenant_code	varchar(64)	NO		NULL
user_name	varchar(64)	NO		NULL
dept_code	varchar(64)	YES		NULL
phone	varchar(64)	YES		NULL
pre_register	varchar(64)	YES		NULL
joined	tinyint(1)	YES		NULL

User devices table:

CREATE TABLE ofUserDevices (
	username VARCHAR(64) NOT NULL, 
	device VARCHAR(256) NOT NULL
);

Field	Type	Null	Key	Default	Extra
username	varchar(64)	NO		NULL
device	varchar(256)	NO		NULL

Group tables

Group metadata table:

The column muc_jid connects with Openfire world. Owner, name and users are already included in Openfire.

CREATE TABLE ofGroupMetadata (
	group_code VARCHAR(64),
	group_name VARCHAR(256),
	tenant_code VARCHAR(64),
	muc_jid VARCHAR(256),
	PRIMARY KEY (group_code)
);

Field	Type	Null	Key	Default	Extra
group_code	varchar(64)	NO	PRI
group_name	varchar(256)	NO	PRI
tenant_code	varchar(64)	NO
muc_jid	varchar(256)	YES		NULL

About

Openfire is a XMPP server licensed under the Open Source Apache License.

Openfire - an Ignite Realtime community project.