Platform Team/Server Kit/sugar-server

From Sugar Labs
Jump to navigation Jump to search

Summary

The core Sugar Server Kit component.

The singular program requires only Python, and obvious dependencies like coreutils, to allow all its services to function properly. It provides basic sugar related services, and uses one CLI tool to manage all its functionality.

Services

The list of services that sugar-server provides. Each service has a described interface to understand how it interact with clients. The counterpart for these interfaces is the sugar-client with a Client API it provides for clients, e.g., Sugar Shell.

If particular service supports RESTfull interface, the HTTP server is started on host with httpd-port port. The content of requests and replies is being transfered using dictionaries in JSON notation.

The resulting dictionary on success, will contain predefined keys:

  • success: OK;

The resulting dictionary on fails, will contain:

  • success: ERR;
  • error, error message.

Service interfaces will operate with the following parameters:

  • uuid, unique identity of the particular Sugar user, i.e., this id should be created for every Sugar profile; it can't be the same as UUID of a XO laptop;
  • serial, serial number of hardware Sugar user is running on, e.g., serial number of a XO laptop;
  • pubkey, SSH public key, this is the exact line that needs to be placed as-is to ~/.ssh/authorized_keys file; note that OLPC XS operates with striped version of public keys.

id

Provide Sugar users registration on a school server. After being registered, Sugar on users side will setup interaction with a school server. See sugar-client project for details from client point of view.

Interface: 

GET /client/status?uuid=UUID

Get information about client's status on a server.

The resulting dictionary, contains:

  • registered, if False, client needs to process [re]registration.
POST /client/register

Process registration on the server.

The input dictionary, contains:

  • uuid
  • nickname
  • serial
  • pubkey

The resulting dictionary, contains:

  • config a dictionary of values that are mapped 1:1 as configuration options of the sugar-client utility. See sugar-client's configuration for details;
  • OLPC XS backwards compatibility keys that are not being processed by sugar-client: backupurl, jabberserver, backuppath.
dict register(str serial, str nickname, str uuid, str pubkey)

Backward compatibility, with OLPC's XS, RPC function to serve registration requests. The resulting data is the same as for RESTfull registration interface. The XML-RPM service will be listening 8080 port on the --host host.

Requirements:

backup

Process backup and restore for students' Journals. The service is accepting RESTfull requests that clients send before starting backup process. If server accepts requests, clients start Rsync'ing Journal data via SSH. The Rsync url needs to be gotten while registration via Id service and will be used without any modification on the client side, i.e., the process is fully server driven.

Note, this backup functionality does not compatible with client tools that work with OLPC XS. The problem is that these tools construct backup url on a client side (using only server host name from backup url given after registration on a server) with relying that every client has its own system user on a server side. That doesn't work with new backup functionality where there is only one system user on a server side and authorisation happens on SSH level (using command option in ~/.ssh/authorized_keys file).

Interface: 

GET /client/backup?uuid=UUID

Check if client can start transfering Journal files using.

The resulting dictionary, contains:

  • accepted, if True, clients can start backup process.

Requirements:

  • The root configuration option should point to the home directory of system user that starts sugar-server process. That needs because clients will SSH to this user to do Rsync backups.

activation

This service is intended to process anti-thief requests XO laptops send to the server during the boot process.

Interface: 

GET /client/lease?serial=SERIAL

Get OLPC anti-thief lease for specified XO's serial number.o

The resulting dictionary, contains:

  • lease, lease content

Service is also listening --activation-port port on the --host host to process TCP requests used by XO's bootstrapping code. If sent data starts from serial number, the service will reply with:

  • STOLEN text if serial number is stated as stolen;
  • lease content found for serial number;
  • UNKNOWN for errors.

Requirements:

  • Current XO's bootstrap code uses TCP interface with having the following numbers hard coded:
    • host needs to be 172.18.0.1,
    • activation-port needs to be 191,
    • XOs use 172.18.96.1 as a gateway while connecting to 172.18.0.1.

keyring

Keyring service is needed to work with activation one. It signs delegated leases for activation requests if pre-existed leases weren't found.

Interface:

There is no public interface, the service is being used internally by sugar-server.

Requires

  • bios-crypto
    bios-crypto client utilities are being used in anti-thief support and should be installed only if sign service is being used.

Configuration

By default, configuration occurs based on several sources (sorted by applied order):

  • /etc/sugar-server.conf system-wide configuration file,
  • ~/.config/sugar-server/config user-wide configuration file,
  • sugar-server's command-line arguments.

Configuration files contain option names equal to command-line arguments. To get the current configuration, call: 

sugar-server config

See sugar-server-templates sources for an example.

Getting involved

  • Report on bugs.
  • Read the HACKING file to know how to contribute with code.

Resources

Retrieved from "https://wiki.sugarlabs.org/index.php?title=Platform_Team/Server_Kit/sugar-server&oldid=70823"