Difference between revisions of "Google Summer of Code 2022"

From XMPP WIKI
Jump to navigation Jump to search
m
m (Remove duplicate separator)
 
(15 intermediate revisions by 4 users not shown)
Line 12: Line 12:


Otherwise, all other info is on [https://summerofcode.withgoogle.com/get-started/ GSoC page]
Otherwise, all other info is on [https://summerofcode.withgoogle.com/get-started/ GSoC page]
[https://developers.google.com/open-source/gsoc/faq Find their FAQ.]
=== Overview ===
{| class="wikitable"
! Date
! Meeting
! Participants
|-
| 2021-12-21
| Kick-off Meeting
| flow, vanitasviate, emus
|-
| 2021-01
| Organisation Application preparation
| emus & XSF members
|-
| 2021-02
| Organisation Application
| emus
|-
| 2021-02
| Projects Application
| Project maintainers
|}


== Overview ==
== Overview ==
Line 20: Line 46:


As there are several disparate projects here, there's variety across several codebases in different languages and with significantly different aims, so take a look through all the ideas - there should be something for everyone here :)
As there are several disparate projects here, there's variety across several codebases in different languages and with significantly different aims, so take a look through all the ideas - there should be something for everyone here :)
* [https://wiki.xmpp.org/web/GSoC#Overview Archive of previous GSoC participation]


== Teaser Tasks ==
== Teaser Tasks ==
Line 26: Line 54:


A list of teaser tasks is given in the [[#Project_Ideas|Project Ideas]] overview, but please join the chat rooms for the respective projects and discuss them there, where mentors will be able to help you and know what you're up to. There are different teasers for different codebases, and more teasers will be appearing here over the next few days.
A list of teaser tasks is given in the [[#Project_Ideas|Project Ideas]] overview, but please join the chat rooms for the respective projects and discuss them there, where mentors will be able to help you and know what you're up to. There are different teasers for different codebases, and more teasers will be appearing here over the next few days.
= Join the group chat! =
Use a regular XMPP client and join the GSoC chat room '''[xmpp:gsoc@muc.xmpp.org?join gsoc@muc.xmpp.org]'''.
How to join:
* Download and [https://xmpp.org/getting-started/ install a client], or [https://xmpp.org/chat?gsoc use a web client]
* Create an account, or use an existing one
* Find, join, and bookmark: [xmpp:gsoc@muc.xmpp.org?join gsoc@muc.xmpp.org].


= Project Ideas =
= Project Ideas =
Line 46: Line 84:
''Deliverables / Expected Results:''<br/>
''Deliverables / Expected Results:''<br/>
* User interface widget to display metadata, suitable for preview image, title, abstract and the original url/domain.
* User interface widget to display metadata, suitable for preview image, title, abstract and the original url/domain.
* Automatic generation of metadata, working with major websites. This should be done in a generic fassion, not targeting a specific website
* Automatic generation of metadata, working with major websites. This should be done in a generic fashion, not targeting a specific website
* Design or reuse a specification for sending metadata with XMPP messages
* Design or reuse a specification for sending metadata with XMPP messages
=== Improve file transfers ===
This topic consists of 3 projects. The second project "On-demand p2p file sharing" can only be achieved by first implementing the first project "Stateless file sharing". "WebRTC file transfer" can be implemented independent of the other two.
==== Stateless file sharing ====
''Brief explanation:'' Attach metadata to HTTP file transfers and display it.<br/>
''Involved Technologies:'' Vala, XMPP, HTTP<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0446.html XEP-0446], [https://xmpp.org/extensions/xep-0447.html XEP-0447], [https://xmpp.org/extensions/xep-0363.html XEP-0363]<br/>
''Deliverables / Expected Results:''<br/>
* Use [https://xmpp.org/extensions/xep-0447.html Stateless file sharing (SFS)] for outgoing HTTP file transfers.
* Send minimal thumbnails (less than 16 pixels) for image file transfers
* Display minimal thumbnails blurred on incoming file transfers (before file is fetched).
==== On-demand p2p file sharing ====
''Brief explanation:'' Allow for on-demand multi-party peer-to-peer file transfers.<br/>
''Involved Technologies:'' Vala, XMPP, Jingle<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0447.html XEP-0447], [https://xmpp.org/extensions/xep-0234.html XEP-0234]<br/>
''Deliverables / Expected Results:''<br/>
* Implement [https://xmpp.org/extensions/xep-0234.html#requesting Jingle File Transfer requests] to request and deliver files.
* Announce availability of Jingle file transfer using [https://xmpp.org/extensions/xep-0447.html Stateless file sharing (SFS)] for outgoing file transfers and after retrieval.
==== WebRTC file transfer ====
''Brief explanation:'' Add support for WebRTC-based file transfers using WebRTC data channels for web compatibility and improved NAT traversal.<br/>
''Involved Technologies:'' Vala, XMPP, Jingle, WebRTC<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0343.html XEP-0343], [https://xmpp.org/extensions/xep-0234.html XEP-0234]<br/>
''Deliverables / Expected Results:''<br/>
* Implement SCTP protocol
* WebRTC data channel protocol
* Use [https://xmpp.org/extensions/xep-0343.html Jingle WebRTC data channel signalling] for file transfers when supported by peer.
=== Rich message support ===
''Brief explanation:'' Add support for creating and displaying rich test messages.<br/>
''Involved Technologies:'' Vala, XMPP, GTK+, Pango<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0393.html XEP-0393], [https://xmpp.org/extensions/xep-0394.html XEP-0394], [https://xmpp.org/extensions/xep-0372.html XEP-0372]<br/>
''Deliverables / Expected Results:''<br/>
* Add rich text features to Dino's chat input box using buttons and well-known keyboard shortcuts for bold, italic, strikethrough, monospace, lists, blockquotes, code blocks, links and mentions.
* Allow users to activate Markdown input, which is instantly converted to rich text during input.
* Send rich text messages using [https://xmpp.org/extensions/xep-0394.html Message Markup] and [https://xmpp.org/extensions/xep-0372.html References] as well as a fallback using [https://xmpp.org/extensions/xep-0393.html Message Styling]
* Apply markup to messages in conversation history via Pango Attributes


= Mellium =
= Mellium =
Line 61: Line 141:
=== Audio/Video Chat ===
=== Audio/Video Chat ===


''Size:'' Large<br/>
''Brief explanation:'' Add support for Audio/Video Communication via Jingle.<br/>
''Brief explanation:'' Add support for Audio/Video Communication via Jingle.<br/>
''Involved Technologies:'' Go, WebRTC, Jingle<br/>
''Involved Technologies:'' Go, WebRTC, Jingle<br/>
Line 68: Line 149:
* Audio and video chat in mellium.im/xmpp that is compatible with [https://conversations.im Conversations]
* Audio and video chat in mellium.im/xmpp that is compatible with [https://conversations.im Conversations]
* File transfer in in mellium.im/xmpp using Jingle sessions (also compatible with Conversations)
* File transfer in in mellium.im/xmpp using Jingle sessions (also compatible with Conversations)
* A demo app to start a conversation
* A demo app to start a conversation (or support in [https://github.com/mellium/communique-tui Communiqué])


=== Group Chat ===
=== Group Chat ===


''Brief explanation:'' Add support for group chats using either Multi-User Chat or Mediated Information Exchange (MIX).<br/>
''Size:'' Small<br/>
''Brief explanation:'' Add support for group chats using Mediated Information Exchange (MIX).<br/>
''Involved Technologies:'' Go<br/>
''Involved Technologies:'' Go<br/>
''Relevant readings:'' [https://xmpp.org/extensions/xep-0369.html XEP-0369: Mediated Information eXchange (MIX)], [https://xmpp.org/extensions/xep-0045.html XEP-0045: Multi-User Chat]<br />
''Relevant readings:'' [https://xmpp.org/extensions/xep-0369.html XEP-0369: Mediated Information eXchange (MIX)]<br />
''Deliverables / Expected Results:''<br/>
''Deliverables / Expected Results:''<br/>
* A well tested library for joining or serving MUC or MIX and a set of integration tests that work against Prosody or Ejabberd server
* A well tested library for joining and serving MIX channels and a set of integration tests that work against Prosody and Ejabberd
* A simple component for hosting MUC or MIX chats
* A simple component for hosting MIX channels


=== End-to-End Encryption ===
=== End-to-End Encryption ===


''Size:'' Large<br/>
''Brief explanation:'' Add support for end-to-end (E2E) encryption using OMEMO, or MLS<br/>
''Brief explanation:'' Add support for end-to-end (E2E) encryption using OMEMO, or MLS<br/>
''Involved Technologies:'' Go, Go Subrepos, OMEMO or MLS<br/>
''Involved Technologies:'' Go, Go Subrepos, OMEMO or MLS<br/>
Line 88: Line 171:
* A well-designed API and well-tested library for encrypting messages with OMEMO or MLS
* A well-designed API and well-tested library for encrypting messages with OMEMO or MLS
* Changes to the Go standard library and sub-repositories to add any missing cryptographic primitives or expose operations that are currently internal only.
* Changes to the Go standard library and sub-repositories to add any missing cryptographic primitives or expose operations that are currently internal only.
= Monal =
''Website:'' https://monal.im/<br/>
''Source Code:'' https://github.com/monal-im/Monal<br/>
''Description:'' Monal is a free Jabber/XMPP client for iOS and macOS <br/>
''Project Contact:'' Thilo Molitor<br/>
''Relevant readings:''<br/>
''Teaser Tasks:'' [https://github.com/monal-im/Monal/issues?q=is%3Aissue+is%3Aopen+label%3AMinor Minor / small issues]<br/>
''Chat:'' [xmpp:monal@chat.yax.im?join monal@chat.yax.im]
=== UI port to SwiftUI ===
Brief explanation: Port UI to SwiftUI language.
Involved Technologies: Objetive-C, SwiftUI
Relevant readings: TBD
Deliverables / Expected Results:
    Port UI to SwiftUI language in core views
    This enables also accessibility to users


= Psi =
= Psi =
Line 121: Line 224:
* The UI should provide next functions: model/view-based chat/group-chat, roster, avatars, statuses, recent (group-)chats, contact list (with groups/tags), contacts management, own status management.
* The UI should provide next functions: model/view-based chat/group-chat, roster, avatars, statuses, recent (group-)chats, contact list (with groups/tags), contacts management, own status management.


= PGPainless =


= Join the group chat! =
[https://pgpainless.org/ PGPainless] is a Java OpenPGP library. While it is not strictly an XMPP related project, it has it has its origins in GSoC and the XMPP community, since it was created as a [https://blog.jabberhead.tk/summer-of-code-2018/ Summer of Code project in 2018].


Use a regular XMPP client and join the GSoC chat room '''[xmpp:gsoc@muc.xmpp.org?join gsoc@muc.xmpp.org]'''.
=== OpenPGP Message Parsing using Parser Generator ===


How to join:
''Brief explanation:'' Enforce OpenPGP message syntax during parsing by using a Parser Generator such as JavaCC<br/>
 
''Involved Technologies:'' Java, Bouncy Castle, EBNF<br/>
* Download and [https://xmpp.org/getting-started/ install a client], or [https://xmpp.org/chat?gsoc use a web client]
''Relevant readings:'' [https://datatracker.ietf.org/doc/html/rfc4880 RFC4880: OpenPGP Message Format]<br/>
* Create an account, or use an existing one
''Deliverables / Expected Results:''<br/>
* Find, join, and bookmark: [xmpp:gsoc@muc.xmpp.org?join gsoc@muc.xmpp.org].
* In the OpenPGP Interoperability Test Suite PGPainless currently fails some tests related to [https://tests.sequoia-pgp.org/#Unusual_Message_Structure unusual message structures].
* The project has the goal to improve PGPainless' score in this category by rewriting/improving the libraries' rather naive [https://github.com/pgpainless/pgpainless/blob/master/pgpainless-core/src/main/java/org/pgpainless/decryption_verification/DecryptionStreamFactory.java message parser logic].
* An ideal implementation would enforce the OpenPGP message structure syntax defined as EBNF. This could be done by using a parser generator such as [https://javacc.github.io/javacc/ JavaCC].

Latest revision as of 13:44, 21 January 2022

Participation

The XSF has plans to be a mentoring organisation for Google Summer of Code 2022. This is an early attempt to ensure good planning and enough time for the application process.

XMPP oriented projects should still add project ideas to the below list.

Organisation: Edward offered to help the organisation. Please reach out to the GSoC chat if you want to support as well of plan to participate in any way: GSoC chat room gsoc@muc.xmpp.org

Dates

The various dates for the program will be expected by the beginning of next year 2022, more information on the GSoC Website

Otherwise, all other info is on GSoC page

Find their FAQ.

Overview

Date Meeting Participants
2021-12-21 Kick-off Meeting flow, vanitasviate, emus
2021-01 Organisation Application preparation emus & XSF members
2021-02 Organisation Application emus
2021-02 Projects Application Project maintainers

Overview

XMPP is an Internet protocol used in many fields, such as the Internet of Things, chat applications, voice and video calls, etc. It's what commerical client alike Google Talk, Whatsapp or Google Hangouts uses as an XMPP-derivative of the protocol uses or in some aspects of XMPP internally, and as well as end-users it's used extensively by enterprises and governments but of course also the open variant propagated and standardised by the XSF.

The XSF is (for GSoC) an umbrella organisation for various XMPP-related projects. As such, there's two tiers involved - the XSF itself, which is responsible for catherding mentors to submit ideas, choosing students etc., and the software projects themselves that then mentor students. Anyone interested in participating in GSoC as an XSF student can join the gsoc@muc.xmpp.org MUC room, where various mentors will be available to answer questions and generally help. Although each idea below lists a possible mentor, this MUC is the best place to start.

As there are several disparate projects here, there's variety across several codebases in different languages and with significantly different aims, so take a look through all the ideas - there should be something for everyone here :)

Teaser Tasks

  • Submit small patches: To assess students applying to GSoC for XSF projects we want them to have submitted some small patches to one of the XMPP projects in advance, as this gives us an idea of their general ability to interact with the projects and submit patches. These should only be an afternoon or two's work, and should not be onerous!

A list of teaser tasks is given in the Project Ideas overview, but please join the chat rooms for the respective projects and discuss them there, where mentors will be able to help you and know what you're up to. There are different teasers for different codebases, and more teasers will be appearing here over the next few days.

Join the group chat!

Use a regular XMPP client and join the GSoC chat room gsoc@muc.xmpp.org.

How to join:

Project Ideas

Dino

Website: https://dino.im/
Source Code: https://github.com/dino/dino
Description: Dino is a modern open-source chat client for the desktop. It focuses on providing a clean and reliable Jabber/XMPP experience while having your privacy in mind.
Project Contact: larma, fiaxh
Relevant readings: Vala Tutorial
Teaser Tasks: Good first issues
Chat: chat@dino.im

Inline link preview

Brief explanation: Add support for attaching and displaying link metadata.
Involved Technologies: Vala, XMPP, HTML, OpenGraph
Relevant readings: OpenGraph protocol
Deliverables / Expected Results:

  • User interface widget to display metadata, suitable for preview image, title, abstract and the original url/domain.
  • Automatic generation of metadata, working with major websites. This should be done in a generic fashion, not targeting a specific website
  • Design or reuse a specification for sending metadata with XMPP messages

Improve file transfers

This topic consists of 3 projects. The second project "On-demand p2p file sharing" can only be achieved by first implementing the first project "Stateless file sharing". "WebRTC file transfer" can be implemented independent of the other two.

Stateless file sharing

Brief explanation: Attach metadata to HTTP file transfers and display it.
Involved Technologies: Vala, XMPP, HTTP
Relevant readings: XEP-0446, XEP-0447, XEP-0363
Deliverables / Expected Results:

  • Use Stateless file sharing (SFS) for outgoing HTTP file transfers.
  • Send minimal thumbnails (less than 16 pixels) for image file transfers
  • Display minimal thumbnails blurred on incoming file transfers (before file is fetched).

On-demand p2p file sharing

Brief explanation: Allow for on-demand multi-party peer-to-peer file transfers.
Involved Technologies: Vala, XMPP, Jingle
Relevant readings: XEP-0447, XEP-0234
Deliverables / Expected Results:

WebRTC file transfer

Brief explanation: Add support for WebRTC-based file transfers using WebRTC data channels for web compatibility and improved NAT traversal.
Involved Technologies: Vala, XMPP, Jingle, WebRTC
Relevant readings: XEP-0343, XEP-0234
Deliverables / Expected Results:

Rich message support

Brief explanation: Add support for creating and displaying rich test messages.
Involved Technologies: Vala, XMPP, GTK+, Pango
Relevant readings: XEP-0393, XEP-0394, XEP-0372
Deliverables / Expected Results:

  • Add rich text features to Dino's chat input box using buttons and well-known keyboard shortcuts for bold, italic, strikethrough, monospace, lists, blockquotes, code blocks, links and mentions.
  • Allow users to activate Markdown input, which is instantly converted to rich text during input.
  • Send rich text messages using Message Markup and References as well as a fallback using Message Styling
  • Apply markup to messages in conversation history via Pango Attributes

Mellium

Website: https://melluim.im/
Source Code: https://mellium.im/code
Description: Mellium is a collection of Go modules related to XMPP.
Project Contact: Sam Whited
Relevant readings: Effective Go, Mellium docs, Mellium API docs
Teaser Tasks: Good first issues
Chat: users@mellium.chat

Audio/Video Chat

Size: Large
Brief explanation: Add support for Audio/Video Communication via Jingle.
Involved Technologies: Go, WebRTC, Jingle
Relevant readings: XEP-0167, XEP-0353
Deliverables / Expected Results:

  • A separate Go library for Jingle that is not XMPP specific (probably, we can discuss design later)
  • Audio and video chat in mellium.im/xmpp that is compatible with Conversations
  • File transfer in in mellium.im/xmpp using Jingle sessions (also compatible with Conversations)
  • A demo app to start a conversation (or support in Communiqué)

Group Chat

Size: Small
Brief explanation: Add support for group chats using Mediated Information Exchange (MIX).
Involved Technologies: Go
Relevant readings: XEP-0369: Mediated Information eXchange (MIX)
Deliverables / Expected Results:

  • A well tested library for joining and serving MIX channels and a set of integration tests that work against Prosody and Ejabberd
  • A simple component for hosting MIX channels

End-to-End Encryption

Size: Large
Brief explanation: Add support for end-to-end (E2E) encryption using OMEMO, or MLS
Involved Technologies: Go, Go Subrepos, OMEMO or MLS
Relevant readings: XEP-0384: OMEMO Encryption, The Messaging Layer Security (MLS) Protocol (draft-ietf-mls-protocol)
Deliverables / Expected Results:

  • If using MLS, an XEP describing behavior and how MLS should be integrated with XMPP
  • A well-designed API and well-tested library for encrypting messages with OMEMO or MLS
  • Changes to the Go standard library and sub-repositories to add any missing cryptographic primitives or expose operations that are currently internal only.

Monal

Website: https://monal.im/
Source Code: https://github.com/monal-im/Monal
Description: Monal is a free Jabber/XMPP client for iOS and macOS
Project Contact: Thilo Molitor
Relevant readings:
Teaser Tasks: Minor / small issues
Chat: monal@chat.yax.im

UI port to SwiftUI

Brief explanation: Port UI to SwiftUI language. Involved Technologies: Objetive-C, SwiftUI Relevant readings: TBD Deliverables / Expected Results:

   Port UI to SwiftUI language in core views
   This enables also accessibility to users

Psi

Website: https://psi-im.org/
Source Code: https://github.com/psi-im/psi
Description: An XMPP client for advanced users.
Project Contact: rion, Tehnick, VitoZz
Relevant readings: [1]
Teaser Tasks: [2]
Chat: psi-dev@conference.jabber.ru

Mediated Information Exchange (MIX)

Brief explanation: Add support for Mediated Information Exchange (MIX).
Involved Technologies: Qt, C++
Relevant readings: XEP-0369: Mediated Information eXchange (MIX)
Deliverables / Expected Results:

  • A set of classes in iris library to support MIX extensions.
  • A MIX management component in Psi itself similar to one implemented for MUC.
  • A Working UI (probably some rework of the current MUC UI to make it compatible with MIX)
  • The solution has to be tested with popular XMPP servers

QML UI

Brief explanation: A modern looking UI for both (group-)chat and roster Involved Technologies: Qt, QML, JavaScript, C++
Relevant readings: https://en.wikipedia.org/wiki/QML
Deliverables / Expected Results:

  • It's a huge task, so expected an implementation of standalone QML/*cross-platform* UI with clear and well-documented API interfaces.
  • The UI may be backed by some mocked C++ code where Psi code should be taken as a guidance. This is perfectly fine to borrow design/API ideas from other clients too.
  • It's assumed the UI will be used not just with Psi. So the branded parts preferably should be kept aside and instead set via API.
  • The UI should provide next functions: model/view-based chat/group-chat, roster, avatars, statuses, recent (group-)chats, contact list (with groups/tags), contacts management, own status management.

PGPainless

PGPainless is a Java OpenPGP library. While it is not strictly an XMPP related project, it has it has its origins in GSoC and the XMPP community, since it was created as a Summer of Code project in 2018.

OpenPGP Message Parsing using Parser Generator

Brief explanation: Enforce OpenPGP message syntax during parsing by using a Parser Generator such as JavaCC
Involved Technologies: Java, Bouncy Castle, EBNF
Relevant readings: RFC4880: OpenPGP Message Format
Deliverables / Expected Results:

  • In the OpenPGP Interoperability Test Suite PGPainless currently fails some tests related to unusual message structures.
  • The project has the goal to improve PGPainless' score in this category by rewriting/improving the libraries' rather naive message parser logic.
  • An ideal implementation would enforce the OpenPGP message structure syntax defined as EBNF. This could be done by using a parser generator such as JavaCC.