Difference between revisions of "Proj-2015-2016-Extensions IPOPO/SRS"

From air
Jump to navigation Jump to search
Line 46: Line 46:
 
* emergent system properties and quality characteristics.
 
* emergent system properties and quality characteristics.
   
==3.1 Requirement X.Y.Z (in Structured Natural Language)==
+
==3.1 Requirement 1 : Creation of client certificates ==
'''Function''':
 
   
 
'''Description''':
 
'''Description''':
  +
Clients certificates are generated by an administrator of an IPOPO application. This certificate is signed using the private certificate of the same application and will be used to remotely access to the IPOPO shell.
   
 
'''Inputs''':
 
'''Inputs''':
  +
User informations. It includes name and email.
   
 
'''Source''':
 
'''Source''':
  +
The information is given by the user to the IPOPO application administrator.
   
 
'''Outputs''':
 
'''Outputs''':
  +
A new certificate signed with the application private certificate.
   
 
'''Destination''':
 
'''Destination''':
  +
The created certificate is given to the user designated in the meta-information of the certificate.
   
 
'''Action''':
 
'''Action''':
  +
* A user must ask for the creation of a certificate to the administrator of an IPOPO application. He will provide his name and his mail address with his request
* Natural language sentences (with MUST, MAY, SHALL)
 
  +
* The administrator shall generate a new certificate using the given information.
* Graphical Notations : UML Sequence w/o collaboration diagrams, Process maps, Task Analysis (HTA, CTT)
 
  +
* The administrator will send the generated certificate to the user who asked for it
* Mathematical Notations
 
  +
* Tabular notations for several (condition --> action) tuples
 
  +
  +
'''Non functional requirements''':
  +
* Easy to use
  +
* The generation can be done on any Linux system (and windows ?)
  +
  +
'''Pre-condition''':
  +
The administrator must have a server (private) certificate
  +
  +
'''Post-condition''':
  +
Users are identifiable from the certificate they are using
  +
  +
'''Side-effects''':
  +
None
  +
  +
  +
==3.3 Requirement 2 : Revocation of client certificates ==
  +
  +
'''Description''':
  +
Client certificates can be revoked. Preventing any access to the IPOPO shell using the revoked certificate.
  +
 
'''Inputs''':
  +
Information identifying a single certificate ( email address ?).
  +
  +
'''Source''':
  +
  +
'''Outputs''':
  +
An entry is asked in the application revocation list.
  +
  +
'''Destination''':
  +
  +
  +
'''Action''':
  +
* TODO
   
 
'''Non functional requirements''':
 
'''Non functional requirements''':
  +
*
   
 
'''Pre-condition''':
 
'''Pre-condition''':
Line 72: Line 110:
   
 
'''Side-effects''':
 
'''Side-effects''':
  +
None
   
 
=4. Product evolution=
 
=4. Product evolution=

Revision as of 17:50, 18 January 2016

Document History
Version Date Authors Description Validator Validation Date
0.1.0 January 18, 2016 Marwan HALLAL, Rémi GATTAZ, Abdelaziz FOUNAS Creation of the document TBC TBC


1. Introduction

1.1 Purpose of the requirements document

This Software Requirements Specification (SRS) identifies the requirements for project StartAir Safe. In case of a open source project, we must present the requirement to others potential contributors. This document is a guideline about the functionalities offered and the problems that the system solves.

1.2 Scope of the product

1.3 Definitions, acronyms and abbreviations

1.4 References

The main page of the project: IPOPO Projects

1.5 Overview of the remainder of the document

2. General description

2.1 Product perspective

2.2 Product functions

2.3 User characteristics

2.4 General constraints

2.5 Assumptions and dependencies

3.Specific requirements, covering functional, non-functional and interface requirements

  • document external interfaces,
  • describe system functionality and performance
  • specify logical database requirements,
  • design constraints,
  • emergent system properties and quality characteristics.

3.1 Requirement 1 : Creation of client certificates

Description: Clients certificates are generated by an administrator of an IPOPO application. This certificate is signed using the private certificate of the same application and will be used to remotely access to the IPOPO shell.

Inputs: User informations. It includes name and email.

Source: The information is given by the user to the IPOPO application administrator.

Outputs: A new certificate signed with the application private certificate.

Destination: The created certificate is given to the user designated in the meta-information of the certificate.

Action:

  • A user must ask for the creation of a certificate to the administrator of an IPOPO application. He will provide his name and his mail address with his request
  • The administrator shall generate a new certificate using the given information.
  • The administrator will send the generated certificate to the user who asked for it


Non functional requirements:

  • Easy to use
  • The generation can be done on any Linux system (and windows ?)

Pre-condition: The administrator must have a server (private) certificate

Post-condition: Users are identifiable from the certificate they are using

Side-effects: None


3.3 Requirement 2 : Revocation of client certificates

Description: Client certificates can be revoked. Preventing any access to the IPOPO shell using the revoked certificate.

Inputs: Information identifying a single certificate ( email address ?).

Source:

Outputs: An entry is asked in the application revocation list.

Destination:


Action:

  • TODO

Non functional requirements:

Pre-condition:

Post-condition:

Side-effects: None

4. Product evolution

5. Appendices

5.1. SRS structure

The document is based on template of the Software Requirements Specification (SRS) inspired of the IEEE/ANSI 830-1998 Standard.

References:

6. Index