https://github.com/mir-evgenii/signaling_server

Signaling server for exchanging SDP datagram between clients to establish peer-to-peer connection via WebRTC. Clients use their public PGP keys as names and sign their messages with private PGP keys.
https://github.com/mir-evgenii/signaling_server

php webrtc-signaling yii

Last synced: 4 months ago
JSON representation

Signaling server for exchanging SDP datagram between clients to establish peer-to-peer connection via WebRTC. Clients use their public PGP keys as names and sign their messages with private PGP keys.

• Host: GitHub
• URL: https://github.com/mir-evgenii/signaling_server
• Owner: mir-evgenii
• License: other
• Created: 2020-04-27T18:07:10.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-31T02:18:13.000Z (about 2 years ago)
• Last Synced: 2024-09-30T22:16:42.740Z (4 months ago)
• Topics: php, webrtc-signaling, yii
• Language: PHP
• Homepage:
• Size: 85 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
## WebRTC signaling server.

Signaling server for exchanging SDP datagram between clients to establish peer-to-peer connection via [WebRTC](https://webrtc.org/). 

Clients use their public PGP keys as names and sign their messages with private PGP keys.

Signaling server uses [Yii 2](http://www.yiiframework.com/) Basic Project Template.

---

### API

---

1. Connect to signaling server.

Request: `host:port/client/add?key=123`

- key - yours public key;

Response success: `{'message': 'isOnline'}`

Response error: `{'message': 'Error'}`

---

2. Get users connected to the signaling server.

Request: `host:port/client/get?keys=123;345;456`

- keys - public keys yours friends;

Response success: `{'online_users': {123, 345}}` or `{'online_users': {}}`

Response error: `{'message': 'Error'}`

---

3. Send message or SDP datagram.

Request: `host:port/message/send?content=text&sender=123&recipient=345&date=2020-04-20%2010:00:00&sign=1234314`

- content - message or SDP datagram;

- sender - your public key;

- recipient - public key your friend;

- date - now date;

- sign - signing the message with your private key;

Response success: `{'message': 'send'}`

Response error: `{'message': 'Error, not save message.'}` or `{'message': 'Error, not verify sign.'}`

---

4. Get messages or SDP datagram.

Request: `host:port/message/get?key=345`

- key - your public key;

Response success: `{'messages-for-client': {{'content': 'SDP', 'sender': '123', 'recipient': '345', 'date': '2020-04-27 10:00:00', 'sign': '1234314'}}}` or `{'messages-for-client': {}}`

Response error: `{'message': 'Error'}`

---

5 Disconnect with the signaling server.

Request: `host:port/client/del?key=123`

- key - your public key;

Response success: `{'message': 'isOffline'}`

Response error: `{'message': 'Error'}`

---