apache / mina-vysper Goto Github PK

Apache Mina Vysper

License: Apache License 2.0

Java 95.79% CSS 0.24% HTML 0.14% JavaScript 3.79% VBScript 0.04%

mina-vysper's Introduction

Apache Vysper

This project aims at delivering a server implementation of both the core and IM parts of the XMPP protocol (as specified in RFCs 3920 + 3921).

"Vysper" is pronounced like in "whisper".

XMPP is an open, secure and extensible instant messaging protocol which has evolved from Jabber.
It provides interoperability features for communication with other XMPP and non-XMPP servers.
It is used and supported by many IM applications, both client and server.

The protocol and its many extensions (called XEPs) are maintained by the XMPP Standards Foundation (XSF.

In addition to the basic protocol and many small extensions, Vysper currently comes with working implementations for
Multi-User Chat (XEP-0045) [5]
and
Publish-Subscribe (XEP-0060) [6]

Building

You need Apache Maven 2, Maven 2.2.1 or later is recommended. Run
mvn install
and you should find a number of JAR files in different target/ folders.
The different build artifacts are compiled in dist/.

Running

There are different ways to run Vysper

A ready-to-run setup is created by the build in
dist/target/appassembler/
Under
dist/target/appassembler/bin
you'll find start scripts for Unix/Mac and Windows.

This makes use of the Spring-based server runtime.
Main class is
org.apache.vysper.spring.ServerMain
and the bean configuration is located in
server/core/src/main/config/spring-config.xml

There is a non-Spring runtime, too:
org.apache.vysper.spring.ServerMain
The source code shows how the different components are plugged together.

It can serve as a template for integrating Vysper in any other application.
The class
org.apache.vysper.xmpp.server.XMPPServer
is built to make the server easily configurable and embeddable.

Configuration

Vysper uses SSL encryption per default.
For this purpose, an TLS certificate is provided.
It is highly recommended to create and use a self-generated certificate!

There is one preconfigured user ([email protected]). The password for this
user is "CHOOSE A SECURE PASSWORD". Please change this password before starting!

Please note that the domain vysper.org is not running an XMPP server.
If you go with the default setup and don't configure your own domain name,
please note that you have to configure your Jabber clients to force the host name
(for example the IP or localhost, depending on how you run it).

Contributing

You can contribute by creating a new issue entry (or working on an existing).

For an overview of all VYSPER related issues, visit https://github.com/apache/mina-vysper/issues

Any contribution is highly welcome. It can be easily reviewed if it comes in form of a Github pull request.

Currently, all coding is done unit test driven. Well, at least it should be ;-)

Please find us on MINA'S developer mailing list [email protected].

mina-vysper's People

Contributors

Stargazers

Watchers

Forkers

ruben0788 cybernomy technologistkj moneytech xiehechong karimhm enexusde dheeyantra isabella232

mina-vysper's Issues

XEP-0443: XMPP Compliance Suites 2021

Please add support of XEP-0443: XMPP Compliance Suites 2021: https://xmpp.org/extensions/xep-0443.html

Which replaces:

XEP-0423: XMPP Compliance Suites 2020: https://xmpp.org/extensions/xep-0423.html
XEP-0412: XMPP Compliance Suites 2019: https://xmpp.org/extensions/xep-0412.html
XEP-0387: XMPP Compliance Suites 2018: https://xmpp.org/extensions/xep-0387.html
XEP-0375: XMPP Compliance Suites 2016: https://xmpp.org/extensions/xep-0375.html
XEP-0302: XMPP Compliance Suites 2012: https://xmpp.org/extensions/xep-0302.html
XEP-0270: XMPP Compliance Suites 2010: https://xmpp.org/extensions/xep-0270.html
XEP-0243: XMPP Server Compliance 2009: https://xmpp.org/extensions/xep-0243.html
XEP-0242: XMPP Client Compliance 2009: https://xmpp.org/extensions/xep-0242.html
XEP-0216: XMPP Intermediate Server 2008: https://xmpp.org/extensions/xep-0216.html
XEP-0212: XMPP Basic Server 2008: https://xmpp.org/extensions/xep-0212.html
XEP-0211: XMPP Basic Client 2008: https://xmpp.org/extensions/xep-0211.html
XEP-0073: Basic IM Protocol Suite: https://xmpp.org/extensions/xep-0073.html

Support of "New" XMPP RFCs

Please add support of last RFCs.

About XMPP RFCs:

Difference noted in RFCs:

Note:

http://jabber.996255.n3.nabble.com/Changes-missing-from-RFC-6120-s-Differences-from-RFC-3920-td30486.html

RFC3920 -> RFC6120

https://tools.ietf.org/tools/rfcdiff/rfcdiff.pyht?url1=https://www.ietf.org/rfc/rfc3920.txt&url2=https://www.ietf.org/rfc/rfc6120.txt

RFC3921 -> RFC6121

https://tools.ietf.org/tools/rfcdiff/rfcdiff.pyht?url1=https://www.ietf.org/rfc/rfc3921.txt&url2=https://www.ietf.org/rfc/rfc6121.txt

Draft but Very Important:

https://tools.ietf.org/html/draft-cridland-xmpp-session-01

Release a new version

The latest published version is 0.7 and was released 10 years ago (on Feb 24, 2011) and a lot of changes happened since. It will be a god idea to release a new version so everyone can take advantage of all the fixes and features that had been written.

TCPEndpoint not offering IoFilterChainBuilder

TCPEndpoint endpoint = new TCPEndpointChainBuilder();
server = new XMPPServer(serverName);
server.addEndpoint(endpoint);
server.start();
endpoint.getFilterChainBuilder().addFirst("custom", new MyCustomFilter());

Always throw a NPE because the field filterChainBuilder in TCPEndpoint is never written.

SCRAM-SHA-1(-PLUS) + SCRAM-SHA-256(-PLUS) + SCRAM-SHA-512(-PLUS) + SCRAM-SHA3-512(-PLUS) supports

Can you add supports of :

SCRAM-SHA-1
SCRAM-SHA-1-PLUS
SCRAM-SHA-224
SCRAM-SHA-224-PLUS
SCRAM-SHA-256
SCRAM-SHA-256-PLUS
SCRAM-SHA-384
SCRAM-SHA-384-PLUS
SCRAM-SHA-512
SCRAM-SHA-512-PLUS
SCRAM-SHA3-512
SCRAM-SHA3-512-PLUS

"When using the SASL SCRAM mechanism, the SCRAM-SHA-256-PLUS variant SHOULD be preferred over the SCRAM-SHA-256 variant, and SHA-256 variants [RFC7677] SHOULD be preferred over SHA-1 variants [RFC5802]".

SCRAM-SHA-1(-PLUS):
-- https://tools.ietf.org/html/rfc5802
-- https://tools.ietf.org/html/rfc6120
SCRAM-SHA-256(-PLUS):
-- https://tools.ietf.org/html/rfc7677 since 2015-11-02
-- https://tools.ietf.org/html/rfc8600 since 2019-06-21: https://mailarchive.ietf.org/arch/msg/ietf-announce/suJMmeMhuAOmGn_PJYgX5Vm8lNA
SCRAM-SHA-512(-PLUS):
-- https://tools.ietf.org/html/draft-melnikov-scram-sha-512
SCRAM-SHA3-512(-PLUS):
-- https://tools.ietf.org/html/draft-melnikov-scram-sha3-512

https://xmpp.org/extensions/inbox/hash-recommendations.html

-PLUS variants:

RFC5056: On the Use of Channel Bindings to Secure Channels: https://tools.ietf.org/html/rfc5056
RFC5929: Channel Bindings for TLS: https://tools.ietf.org/html/rfc5929
Channel-Binding Types: https://www.iana.org/assignments/channel-binding-types/channel-binding-types.xhtml
RFC 9266: Channel Bindings for TLS 1.3: https://tools.ietf.org/html/rfc9266

LDAP:

RFC5803: Lightweight Directory Access Protocol (LDAP) Schema for Storing Salted: Challenge Response Authentication Mechanism (SCRAM) Secrets: https://tools.ietf.org/html/rfc5803

HTTP:

RFC7804: Salted Challenge Response HTTP Authentication Mechanism: https://tools.ietf.org/html/rfc7804

2FA:

Extensions to Salted Challenge Response (SCRAM) for 2 factor authentication: https://tools.ietf.org/html/draft-melnikov-scram-2fa

IANA:

Simple Authentication and Security Layer (SASL) Mechanisms: https://www.iana.org/assignments/sasl-mechanisms/sasl-mechanisms.xhtml

Linked to:

scram-sasl/info#1

Startup script fails: "Could not find or load main class org.apache.vysper.spring.ServerMain"

In https://github.com/apache/mina-vysper/blob/685a690b3aa141f7ab9f275c8c29b0b043232dd4/README.md:

A ready-to-run setup is created by the build in
dist/target/appassembler/
Under
dist/target/appassembler/bin
you'll find start scripts for Unix/Mac and Windows.

When I run mvn install and then try to run the startup script, here's the result:

Error: Could not find or load main class org.apache.vysper.spring.ServerMain
Caused by: java.lang.ClassNotFoundException: org.apache.vysper.spring.ServerMain

Indeed, I cannot find a class called org.apache.vysper.spring.ServerMain in the repository. There are several ServerMain classes but not one in package org.apache.vysper.spring.

Am I doing something wrong? Or is there an easy fix to get Vysper running?

TLS-handshake fails and certificates not recognized

When I run the server with the standard certificate stuff, the server successfully starts and is reachable.
Though the TLS-handshakes fail.

And when I try to configure vysper to use my certificate, it fails to start.