Merge pull request #215 from linathedog/devel

Devel

CODE_OF_CONTACT.md

@@ -0,0 +1,48 @@
+# RCIAM Code of Conduct
+
+## Introduction
+
+This Code of Conduct outlines expectations for contributors to the RCIAM project, fostering a welcoming, inclusive, and collaborative environment for all participants.
+
+## Our Standards
+
+Examples of behavior that contribute to creating a positive environment include:
+
+- Using welcoming and inclusive language  
+- Being respectful of differing viewpoints and experiences  
+- Gracefully accepting constructive criticism  
+- Focusing on what is best for the community  
+- Showing empathy towards other community members  
+
+Additional expectations specific to RCIAM:
+
+- **Focus on Security**: Security is central to RCIAM. Contributors are expected to follow best practices, write secure code, and report vulnerabilities responsibly.  
+- **Promote Interoperability**: Contributions should align with Identity and Access Management (IAM) standards and protocols, including those outlined by the AARC Blueprint Architecture (AARC BPA). This ensures that RCIAM remains interoperable with other frameworks and services, fostering seamless integration and compliance within federated environments.
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances  
+- Trolling, insulting/derogatory comments, and personal or political attacks  
+- Public or private harassment  
+- Publishing others' private information, such as a physical or electronic address, without explicit permission  
+- Other conduct which could reasonably be considered inappropriate in a professional setting  
+
+## Our Responsibilities
+
+Community leaders (e.g., RCIAM maintainers and technical leads) are responsible for upholding this Code of Conduct. They are tasked with clarifying and enforcing standards of acceptable behavior and will take appropriate and fair corrective action in response to behavior deemed inappropriate, threatening, offensive, harmful, or inconsistent with RCIAM's goals of security, privacy, and interoperability.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct. They will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within RCIAM project spaces (e.g., GitHub repositories, issue trackers) and public spaces when individuals represent the project or community. Examples of representation include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior can be reported by emailing `[email protected]`. All complaints will be reviewed and investigated promptly and fairly. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/), version 2.1.

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing to RCIAM Open Source Software
+
+Thank you for considering contributing to RCIAM Open Source Software.
+
+Please note that we welcome all forms of user feedback and are generally open  
+to many forms of collaboration, but please read this document carefully before proceeding.
+
+## User Feedback
+
+### Reporting Problems
+
+We welcome all feedback you may have when using any of our tools and services.
+
+If you encounter a problem, please contact `[email protected]`
+
+### Suggesting Enhancements
+
+To suggest new functionalities and possible future developments,  
+please contact `[email protected]`
+or open an issue on the respective **GitHub repository**,  
+and specify whether your suggestion is a "New Feature" or an "Improvement."
+
+## Contributing to the Development
+
+Development of all RCIAM tools and services is aligned with our roadmap and any functional requirements we have.
+
+External contributions can be accepted if they provide functionality RCIAM  
+deems appropriate and are of acceptable quality.  
+Specific requirements and criteria may apply to specific tools.
+
+If you want to contribute to RCIAM tools and services,  
+please contact `[email protected]` before proceeding.
+
+### Practical Matters
+
+RCIAM reserves the right to accept or reject any contribution.

README.md

@@ -48,23 +48,23 @@ If we need to set the project to communicate with deployment agents we will need
 - an authorization key for the push endpoint
 
 
-##### 1) Initialise/Configure Tenant
-

-a) Setup the tenants configuration file.
+#### **Initialise/Configure Tenant**
+
+1) Setup the tenants configuration file.
 ```
 federation-registry-backend-api/JavaScript/config.json
 ```
 
-b) Initialise tenant in the database.  An example of an initialisation script can be seen in the **setup_tenant.sql** file
+2) Initialise tenant in the database.  An example of an initialisation script can be seen in the **setup_tenant.sql** file
 - **Authentication:** Configure the Issuer that will be used for authentication providing also the Client Id and Client Secret.
 - **User Roles:**  Configure the user roles and the entitlements that grant them and associate the with [role actions](#role-actions).  (The use of the example roles is recommended) 
 - **Deployment Agents:** Configure the deployment agents that will be connected to the Federation Registry instance.
 
 \*Note: If you are running federation registry in a development instance consider using a [mock deployer](https://github.com/rciam/rciam-federation-registry-agent/tree/mock-deployer). 
 
 
-##### 1) Backend API
-

+#### **Backend API**
+
 **Configure Environment File**
 `federation-registry-backend-api/JavaScript/.env`
 
@@ -91,8 +91,8 @@ TOKEN_KEY = token_used_for_encription
 }
 ```
 
-##### 2) Front End
-

+#### **Front End**
+
 For the frontend we need to configure where the backend api is located:
 `federation-registry-frontend/src/config.json`
 
@@ -104,11 +104,10 @@ For the frontend we need to configure where the backend api is located:
   },
   "basename": "/",
 }
-
 ```
 
-##### **3) AMS Agent**
-

+#### **AMS Agent**
+
 Ams Agent is responsible for
 - Creating the necessary Topics and Subscriptions in the AMS.
 - Pushing Deployment messages from the Federation Registry to the AMS. 
@@ -165,7 +164,8 @@ $ node app.js
 Each user role is associated with a set of actions. Here is a list of the supported actions. 
 
 ##### Simple Actions 
-- **get_user**: User can has access to it's own personal information.
+
+- **get_user**: User has access to it's own personal information.
 - **get_own_services**: User can get a list of their services.
 - **get_own_service**: User can view their own services.
 - **get_own_petitions**: User can view requests for their services.

codemeta.json

@@ -0,0 +1,38 @@
+{
+    "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
+    "type": "SoftwareSourceCode",
+    "author": [
+        {
+            "id": "_:author_1",
+            "type": "Person",
+            "affiliation": {
+                "type": "Organization",
+                "name": "Web Developer at Grnet"
+            },
+            "email": "[email protected]",
+            "familyName": "Kozadinos",
+            "givenName": "Andreas "
+        }
+    ],
+    "contactPoint": {
+        "type": "ContactPoint",
+        "email": "[email protected]"
+    },
+    "codeRepository": "https://github.com/rciam/rciam-federation-registry",
+    "dateCreated": "2024-11-25",
+    "datePublished": "2021-01-12",
+    "description": "The federation registry provides a secure web interface through which service operators can register and manage their OpenID Connect and SAML based service. A federation registry instance can serve multiple tenants and supports different AAI proxy technologies(Keycloak, SimpleSAMLphp, SATOSA (TODO), MITREid Connect). Services can be managed through the portal and are deployed by sending configuration messages to deployment agents that run in parallel with this project. Messages are exchanged using ARGO Messaging Service.",
+    "keywords": "aai",
+    "name": "RCIAM Federation Registry ",
+    "programmingLanguage": [
+        "Javascript",
+        "HTML",
+        "CSS",
+        "Handlebars"
+    ],
+    "version": "1.3.7",
+    "contIntegration": "https://github.com/rciam/rciam-federation-registry/issues",
+    "codemeta:continuousIntegration": {
+        "id": "https://github.com/rciam/rciam-federation-registry/issues"
+    }
+}