summaryrefslogtreecommitdiffstats
path: root/src/rest.h
Commit message (Collapse)AuthorAgeFilesLines
* rest: add POST /oglive/add and POST /oglive/deleteAlejandro Sirgo Rica2024-11-111-0/+2
| | | | | | | | | | | | | | | | | Add API to register and delete oglives from the database. POST /oglive/add Register an installed oglive in the database, if the entry already exists update its creation date. Example request payload: {"name": "ogrelive-6.1.0-26"} POST /oglive/delete Remove an installed oglive from the database Example request payload: {"name": "ogrelive-6.1.0-26"}
* src: add last client command context and use it for image creationOpenGnSys Support Team2024-10-311-1/+10
| | | | | | | Add last client command context that is used in the request to client. This allows to remove the stub image entry in the database in case that the image creation fails.
* src: place last client command information in structOpenGnSys Support Team2024-10-311-3/+5
| | | | just a preparation, no functional changes are intended.
* rest: remove unused probeOpenGnSys Support Team2024-09-301-1/+0
| | | | unused since 87be2ce08
* rest: remove scheduler codeOpenGnSys Support Team2024-09-171-29/+2
| | | | Put ogserver into diet, remove this feature, including pending command queue.
* rest: add GET /efiAlejandro Sirgo Rica2024-09-111-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add GET /efi request to obtain information about the client's boot entries. Field inside the /refresh payload 'efi': { 'entries': [ { "order": 0, "name": "Boot0000", "active": false, "description": "grub" }, { "order": 1, "name": "Boot0001", "active": true, "description": "UEFI: PXE IP4 Realtek PCIe GBE Family Controller" } ] } If the client is not a EFI system it won't add the 'efi' field. If an entry is not in the boot order it won't have the 'order' field. GET /efi resquest payload structure: { 'clients': ['10.141.10.21', '10.141.10.22'] } GET /efi response's structure: { 'clients': [ { 'ip': '10.141.10.21', 'entries': [ { "order": 0, "name": "Boot0000", "active": false, "description": "grub" }, { "order": 1, "name": "Boot0001", "active": true, "description": "UEFI: PXE IP4 Realtek PCIe GBE Family Controller" } ] }, { 'ip': '10.141.10.22', 'entries': [] } ] } The client with ip 10.141.10.22 is a BIOS system. If an entry does not appear in the boot order it won't have the 'order' field.
* rest: add cache/fetchv1.2.5-17Alejandro Sirgo Rica2024-08-091-0/+2
| | | | | | | | | | | | | | | | | | | Add POST cache/fetch request to request download of images in the client's cache. Resquest payload structure: { 'clients': ['10.141.10.21', '10.141.10.22'] 'image': 'windows.img' 'type': 'TIPTORRENT' 'repository': '12.141.10.2' } The clients listed in the 'clients' field will receive a cache/fetch POST request with the payload received by the server without the 'clients' field. The clients respond with the contents of their cache so the server can update the database.
* rest: add GET,POST /image/restrictOpenGnSys Support Team2024-07-171-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Allow to restrict image to scope: POST /image/restrict { "image" : 49, "scopes" : [ 1,3 ] } response: 200 OK This restricts image with ID 49 to scopes 1 and 3. You can also fetch the current list of restrictions: GET /image/restrict { "image" : 49 } response: 200 OK { "image" : 49, "scopes" : [ 1,3 ] } Existing limitations in this interface: - Only restriction of image to center is possible at this moment. - This is only used by ogCP to validate if this is possible, no existing code in the ogserver uses this to restrict POST image/restore. This is a usability feature.
* rest: add shell/listAlejandro Sirgo Rica2024-06-251-0/+1
| | | | | | | | | | | | Add GET shell/list request to obtain the list of scripts available in /opt/opengnsys/client/shell Resquest payload structure: no paylaod Response's structure: { 'scripts': ['script', 'script2'] }
* rest: add timestamp to shell/outputOpenGnSys Support Team2024-06-211-0/+1
| | | | Provide a timestamp that tells when the command output from client was received.
* rest: add cmd to shell/outputOpenGnSys Support Team2024-06-211-0/+1
| | | | | Add "cmd" field to json that provides the original command string, so it is provided with the output and the return code.
* rest: add retcode to shell/outputOpenGnSys Support Team2024-06-211-1/+4
| | | | Add retcode field to specify return code of shell invocation.
* rest: Add /client/movev1.2.5-12OpenGnSys Support Team2024-06-171-0/+1
| | | | | | | | | | | | | | | | Add URI to allow a POST request to move clients to a new room/folder. Request POST /client/move: { "clients": [ "192.168.56.11" ], "room": 10, "folder_id": 0, } If folder_id is zero then that means computer is not stored in a folder.
* rest: Add /center/infoOpenGnSys Support Team2024-06-121-0/+1
| | | | | | | | | | | | Add URI to allow a GET request to obtain info about a center (name, id and comment of the center as of now). To use this uri, simply send a GET request with a json containing the id of the center whose info needs to be consulted: curl -X GET -H "Authorization: $API_KEY" http://127.0.0.1:8888/center/info -d '{"id":1}' based on work from Javier Hernandez.
* rest: add cache/deleteAlejandro Sirgo Rica2024-05-301-0/+2
| | | | | | | | | | | | | | | | | | | Add POST cache/delete request to request deletion of images in the client's cache. Resquest payload structure: { 'clients': ['10.141.10.21', '10.141.10.22'] 'images': ['windows.img', 'linux.img'] } The clients listed in the 'clients' field will receive a cache/delete POST request with the 'clients' field removed and only containing 'images' from the payload received by the server. Each client will try to delete as many images as available in their cache from the list of files in 'images'. The clients will give response with the contents of the cache so the server can update the database.
* rest: add cache/listAlejandro Sirgo Rica2024-05-301-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add GET cache/list request to obtain information about the client's cache. Resquest payload structure: { 'clients': ['10.141.10.21', '10.141.10.22'] } Response's structure: { 'clients': [ { 'ip': '10.141.10.21', 'cache_size': 2894572304857, 'images': [ {name:'img1', size: 87283902343, checksum: '5d4dcc677bc19f40a647d0002f4ade90'}, {name:'img2', size: 894572304857, checksum: '3eb22f888f88a55ad954f55644e1192e'} ] }, { 'ip': '10.141.10.22', 'cache_size': 49872839023434, 'images': [ {name:'img2', size: 894572304857, checksum: '3eb22f888f88a55ad954f55644e1192e'} ] } ] } Both 'cache_size' and the values in 'image_sizes' are provided as bytes. If a client has no cache partition the payload will include it as: ... { 'ip': '10.141.10.22', 'cache_size': 0, 'images': [] } ...
* rest: Add uri to update folder nameJavier Hernandez2024-02-051-0/+1
| | | | | | Add support to update computer folder name Add support to update room folder name
* rest: Add uri to update roomJavier Hernandez2024-02-011-0/+1
| | | | | | | | Add uri to allow the change of a room's properties, such as 'name', 'gateway' or 'netmask' Reject update if new name is already being used by any room of the center where the room is located
* rest: Add uri to update centerJavier Hernandez2024-02-011-0/+1
| | | | | | | | Add uri to allow the change of a center's properties such as 'name' or 'comment' Refuse to update center's name if that name is already in use by another center. This is because a center should not share name with another one.
* rest: update og_uri_handle with new folder commandsOpenGnSys Support Team2024-01-111-0/+2
| | | | Add folder/add and folder/delete, otherwise logging shows "unknown"
* rest: missing POST /image/update in syslogOpenGnSys Support Team2023-12-211-0/+1
| | | | | | Update it so it shows in syslog, instead of unknown: Dec 19 18:31:18 ogserver ogserver[1133]: 127.0.0.1:36538 POST /unknown clients=150.128.34.25
* rest: add POST image/updateOpenGnSys Support Team2023-12-191-0/+1
| | | | add explicit API to update an image
* rest: add GET /room/infoOpenGnSys Support Team2023-11-301-0/+1
| | | | | | | Add GET /room/info to obtain room information, this includes the name, gateway and netmask. curl -X GET -H "Authorization: $API_KEY" http://127.0.0.1:8888/room/info -d '{ "id" : 1 }
* rest: add POST repository/updatev1.2.5-3Javier Hernandez2023-11-241-0/+1
| | | | | | | | | | Add POST repository/update request to update repository. Repository is identified by its id, that is provided in the payload. This can be tested with curl like: curl -X POST -H "Authorization: $API_KEY" http://127.0.0.1:8888/repository/update -d '{ "repo_id" : 16, "center" : 3, "name": "newName", "ip":"127.0.0.1" }'
* rest: revisit loggingOpenGnSys Support Team2023-11-231-0/+53
| | | | | | | | | | | | | | | | Skip logging for the following REST API invocations: - GET /scopes - GET /clients - POST /clients (for legacy web console only) The web front-end generated very frequent requests for this. Update logging format to: 127.0.0.1:54637 POST /wol clients=192.168.2.130 to include client IP address.
* rest: support DELETE HTTP request methodJose M. Guisado2023-08-231-0/+1
| | | | | | | | | | | | | | Reuse endpoints in order to add deletion operation such as "/server". This way there is no need to declare a different if/else block in order to parse a new URI for the new "*/delete" endpoint. Current deletion operations are implemented using a different endpoint name such as "/client/delete", "/center/delete" with POST request method. Endpoints using "/delete" suffix may not be removed for backwards compatibility. Adding HTTP method DELETE support for endpoints such as "/center" or "/client" can use the already existing *_post_delete* functions.
* core: add X-Sequence header supportv1.2.2Jose M. Guisado2023-06-131-0/+1
| | | | | | | | | | | | | | | Add non-standard HTTP header "X-Sequence" to the header section of requests (og_send_request) sent to a connected client. Define a starting sequence number when creating a new instance of struct og_client inside og_server_accept_cb. This sequence number is incremented by one for each outgoing request from ogServer. This sequence number is checked when receiving a response from a connected client, if they do not match the connection is dropped. Use sequence 0 for out-of-band commands (reboot, poweroff, stop). Any client response with header "X-Sequence: 0" bypasses sequence check.
* #915 Add last_cmd to GET /clients APIJavier Sánchez Parra2022-05-181-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | "last_cmd" json object contains information of the last command executed by the correspondent client. For now, it only includes "result" string property, which stores "success" if the last command finished correctly or "failure" on the contrary. To populate "result" property, this commit also adds "last_cmd_result" enum attribute to og_client struct. Client response processing fills this attribute according to its success. Clients in WOL_SENT state always have last_cmd->result = "unknown". Request: GET /clients Response: 200 OK { "clients": [ { "addr": "10.141.10.102", "state": "WOL_SENT", "last_cmd": { "result": "unknown" } }, { "addr": "10.141.10.101", "state": "OPG", "speed": 1000, "last_cmd": { "result": "success" } }, { "addr": "10.141.10.100", "state": "OPG", "speed": 1000, "last_cmd": { "result": "failure" } } ] }
* #915 release existing client on reconnectionsOpenGnSys Support Team2022-01-211-0/+1
| | | | | Trasient network problems might result in duplicated clients, drop client object if it already exists before creating a new one.
* #915 remove temporary file to store shell outputOpenGnSys Support Team2022-01-181-0/+1
| | | | | Remove legacy behaviour, store it in the client object instead of a temporary file.
* #1065 Add support for client eventsJose M. Guisado2021-12-011-0/+2
| | | | | | | | ogServer supports events from clients in an agent mode (linux/windows). Client sends event information (eg. user login/logout) via a 103 Early Hints http response message.
* #1065 client: add support for ogclient win stateJose M. Guisado2021-11-171-0/+1
| | | | | | | | | ogClient can be run in windows mode, enabling connection with ogServer when running on a Windows machine. Don't expect the same payload in windows mode as a in live or virtual. Client in windows mode does not send partition setup information, only the status/state. (same case for linux mode)
* #1065 client: add support for ogclient linux stateJose M. Guisado2021-11-171-0/+1
| | | | | | | | | | ogClient can be run in linux mode, intended for exposing some ogServer commands when running in a linux distribution. When connecting with a client in linux mode, do not expect a full partition setup response. Just expect a 'status', and then accept the connection without updating any partition information in the database.
* #1061 add timeout to pending scheduled commandsJose M. Guisado2021-09-061-0/+2
| | | | | | | | | | | Pending schedule commands can deny ogLive boot of clients due to filling of pending cmd queue with commands such as "Iniciar Sesión". For example: Using RemotePC to serve clients that do not boot into ogLive will fill up the pending command queue with "Iniciar Sesión". Introduce a safety timeout for pending (scheduled) commands to avoid this situation.
* move json function declarations to json.hOpenGnSys Support Team2021-06-101-4/+0
| | | | | | | | These function declarations belong to json.h: int og_json_parse_partition_setup(json_t *element, struct og_msg_params *params); int og_json_parse_create_image(json_t *element, struct og_msg_params *params); int og_json_parse_restore_image(json_t *element, struct og_msg_params *params);
* #915 Add schedule/commandJose M. Guisado2021-06-091-0/+4
| | | | | | | | | Enables ogserver to schedule commands (also referred as actions in legacy web console jargon). This feature enables ogserver to write in the "acciones" table in order to have full capabilities for command scheduling purposes, thus not depending in the legacy web console to insert into "acciones" table.
* #995 Add link speed parsing to client probe responseJose M. Guisado2021-05-041-0/+1
| | | | | | If a probe response contains speedinformation, parse and store it inside the client struct. Speed is interpreted as an unsigned integer representing Mbit/s.
* #915 only API REST is supportedOpenGnSys Support Team2021-05-041-1/+0
| | | | Socket hidra API has been removed, all connections use a REST API.
* #580 remove old keepalive codeOpenGnSys Support Team2021-05-041-1/+0
| | | | Needed by the old socket Hydra that does not exist anymore
* #1022 increase maximum API REST request sizeOpenGnSys Support Team2021-02-041-1/+1
| | | | | Software inventory generates a request larger that 64 Kbytes. Rise the maximum API REST request size to 128 Kbytes.
* #1004 Add GET /imagesJavier Sánchez Parra2020-09-291-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit adds GET /images to the ogServer REST API. This call returns information of all the images in ogServer. Example response: { "images": [ { "filename": "ubuntu.img", "datasize": 2150400000, "size": 613476223, "modified": "Wed Sep 23 10:37:36 2020", "permissions": "744" }, { "filename": "test.img", "datasize": 2150400000, "size": 613236475, "modified": "Tue Sep 29 08:57:47 2020", "permissions": "744" } ], "disk": { "total": 52573995008, "free": 39624544256 } }
* #971 rename sources folder to srcOpenGnSys Support Team2020-06-261-0/+97
Use the same folder as in ogClient.