Proj-2013-2014-Open DynDNS/SRS
The document provides a template of the Software Requirements Specification (SRS). It is inspired of the IEEE/ANSI 830-1998 Standard.
Read first:
- http://www.cs.st-andrews.ac.uk/~ifs/Books/SE9/Presentations/PPTX/Ch4.pptx
- http://en.wikipedia.org/wiki/Software_requirements_specification
- IEEE Recommended Practice for Software Requirements Specifications IEEE Std 830-1998
Version | Date | Authors | Description | Validator | Validation Date | ||
---|---|---|---|---|---|---|---|
0.1.0 | 27/1/2014 | Lionel Boey | Projet requirement | Thomas Calmant | 28/1/2014 | ||
0.1.1 | 10/2/2014 | Lionel Boey | Overview of project | Thomas Calmant | 11/1/2014 | ||
1.0.0 | 17/2/2014 | Lionel Boey | Preliminary contract | Thomas Calmant | 18/2/2014 | ||
1.0.0 | 20/3/2014 | Lionel Boey | Completed version | Thomas Calmant | 21/3/2014 |
}
1. Introduction1.1 Purpose of the requirements documentThe purpose of this Software Requirement Document (SRS) is to provide detailed overview of our 4th year RICM project called Open DynDNS. Being an open-source project, this document can be used as a guideline and reference to potentiel future contributors and designers to take part in software delivery lifecycle (SDLC) processes. In short, this document defines how our client, team and our tutor see the product and its functionality by understanding the user interface, hardware and software requirements. 1.2 Scope of the product
1.3 Definitions, acronyms and abbreviations
1.4 References
1.5 Overview of the remainder of the documentThe following parts of this document provide a general description of the project. Section 2 describes the characteristics of the users of this application, some of the constraints encountered while working on the project and a few assumptions and dependencies made by the developers Section 3 provides primarily technical documentations for developers such as the hardware used for this application, the functional requirements, data requirements and constraints and assumptions made while designing and implementing the Open DynDNS solution. It also gives the user viewpoint of product. Section 4 is for supporting information. 2. General descriptionThis section of the SRS should describe the general factors that affect 'the product and its requirements. It should be made clear that this section does not state specific requirements; it only makes those requirements easier to understand. 2.1 Product perspectiveThe daemon/server couple shoule be capable of deploying into any traditional network. For each version of the project :
-Daemon -> public wifi network. -Server -> any public ISP subscription network. The daemon on the client side makes use of various IP detecting websites to determine the correct public IP address of itself.
-Daemon and client -> any traditional network of a small company mDNS clients are installed on each participating machine in the multicast network for the distributed protocole to function. It should be reminded that mDNS is installed above a standard internal DNS system and therefore the updates should be taken into account by the DNS server. 2.2 Product functionsThis subsection of the SRS should provide a summary of the functions that each version of the software will perform :
The daemon/server couple will communicate with each other to update periodically the dynamic IP address of the client-side daemon. This update is stored into a FLASK webserver (JSON format) and also directly into the database files of the bind9 DNS server
When a newly arrived client or service server arrives on the network, it should be able to locate the DNS servers immediately and sends a REST update to the said DNS server with its new local IP address. From then onwards, the client running the daemon will be accessible by anyone in the network. The client also automatically sends a REST update when it leaves the network.
If UPnP is enable on this network, any external user will be able to resolve DNS names to all the machines in the private multicast network. 2.3 User characteristicsThere are 2 main groupe of user that interacts with the system : Administrator Admins should have basic knowledge of DNS configurations and basic Python understanding, as initial domain configurations are required in Bind9 and hosts should be manually declared beforehand in the REST webserver to prevent unwanted hosts adding themselves to the domain
2.4 General constraints2.5 Assumptions and dependencies
- UPnP are most likely disabled on any public network and routers of a small private network of a company - HTTP requests (GET, PUT, POST) are enabled on most public wifi network and small private network of a company - DNS queries are enabled on any network 3.Specific requirements, covering functional, non-functional and interface requirements
3.1 Requirement X.Y.Z (in Structured Natural Language)Function: To dynamically updates the public IP address of a host on a DNS server whenever the host is mobile and is located in a foreign network Description: Implement an open source dynamic DNS server and demon to run on various device (PC, laptop, Android tablet etc) Inputs: Dynamic IPs Source: Users who host their websites or depositories behind a router/modem with dynamic IP Outputs: Dynamic DNS updates Destination: Open DynDNS server Action:
Non functional requirements:
Pre-condition:
- Raspberry PI - Android tablette (Nexus 10) - 2 machine running on Linux - Routers must set-up port forwarding for HTTP and DNS
- Ubuntu desktop - mDNS daemons - Flask API and Flask REST-ful - Bind9
Post-condition:
4. Product evolution5. Appendices6. Index |