https://github.com/awslabs/fhir-works-on-aws-authz-rbac

A role based access control implementation of the FHIR Works on AWS framework, utilizing Cognito and User Groups to perform authorization

https://github.com/awslabs/fhir-works-on-aws-authz-rbac

Science Score: 10.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 14 committers (7.1%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.8%) to scientific vocabulary

Keywords

aws fhir fhir-works healthcare hl7 nodejs typescript

Keywords from Contributors

diagram dynamodb-cli labels interaction
Last synced: 6 months ago · JSON representation

Repository

A role based access control implementation of the FHIR Works on AWS framework, utilizing Cognito and User Groups to perform authorization

Basic Info
  • Host: GitHub
  • Owner: awslabs
  • License: apache-2.0
  • Language: TypeScript
  • Default Branch: mainline
  • Homepage:
  • Size: 549 KB
Statistics
  • Stars: 23
  • Watchers: 8
  • Forks: 16
  • Open Issues: 0
  • Releases: 0
Archived
Topics
aws fhir fhir-works healthcare hl7 nodejs typescript
Created over 5 years ago · Last pushed almost 3 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Codeowners

README.md

fhir-works-on-aws-authz-rbac

This GitHub repository has been migrated. You can now find FHIR Works on AWS at https://github.com/aws-solutions/fhir-works-on-aws.

Purpose

Please visit fhir-works-on-aws-deployment for overall vision of the project and for more context.

This package is an implementation of the authorization interface from the FHIR Works interface. It uses role based access control (RBAC) to limit access to certain resource types and what operations one can do on those resource types. Cognito User Groups are used to determine which roles the user has. The User Group information is passed along in the OAuth access token when a user makes a request to the FHIR API. This means that the user must correctly obtained an access token from Cognito by using scopes of either:

  • openid profile Must have both
  • aws.cognito.signin.user.admin

To use and deploy this component (with the other 'out of the box' components) please follow the overall README

Infrastructure

This package assumes certain infrastructure:

  • Cognito - is our idP
    • Users - created and managed inside of Cognito
    • User Groups - Used to determine which role the users have
    • OAuth - Used to provide an access token to the user. To understand the flow more see this link

Usage

For usage please add this package to your package.json file and install as a dependency. For usage examples please see the deployment component's package.json

Authorization rules

The rules are defined very simply and are in this format:

txt { <name-of-role>: { operations: [<array-of-operations-that-can-be-performed>], resources: [<array-of-resource-types>] } }

For a working example please see RBACRules.ts in the deployment package

Dependency tree

This package is dependent on:

Known issues

For known issues please track the issues on the GitHub repository

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.

Owner

  • Name: Amazon Web Services - Labs
  • Login: awslabs
  • Kind: organization
  • Location: Seattle, WA

AWS Labs

GitHub Events

Total
  • Fork event: 1
Last Year
  • Fork event: 1

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 43
  • Total Committers: 14
  • Avg Commits per committer: 3.071
  • Development Distribution Score (DDS): 0.721
Past Year
  • Commits: 6
  • Committers: 4
  • Avg Commits per committer: 1.5
  • Development Distribution Score (DDS): 0.667
Top Committers
Name Email Commits
Robert Smayda s****4@g****m 12
Nestor Carvantes c****s@g****m 7
rsmayda r****a@u****m 5
Tim Nguyen n****2@u****m 4
Sukeerth Vegaraju s****u@y****n 3
dependabot[bot] 4****]@u****m 2
kcadette 7****e@u****m 2
Yanyu Zheng y****0@c****u 2
carvantes c****s@u****m 1
Sanket Dharwadkar s****d@a****m 1
nisankep 1****p@u****m 1
smayda s****a@a****m 1
Amazon GitHub Automation 5****o@u****m 1
awsbakha 7****a@u****m 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 2
  • Total pull requests: 43
  • Average time to close issues: 3 months
  • Average time to close pull requests: 3 days
  • Total issue authors: 1
  • Total pull request authors: 10
  • Average comments per issue: 2.5
  • Average comments per pull request: 0.16
  • Merged pull requests: 40
  • Bot issues: 0
  • Bot pull requests: 2
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • arthuston (2)
Pull Request Authors
  • rsmayda (14)
  • nguyen102 (7)
  • carvantes (7)
  • ssvegaraju (4)
  • Bingjiling (4)
  • dependabot[bot] (2)
  • SanketD92 (1)
  • nisankep (1)
  • kcadette (1)
  • awsbakha (1)
Top Labels
Issue Labels
enhancement (2) help wanted (1)
Pull Request Labels
size/xs (9) size/s (8) documentation (7) dependencies (4) size/xl (2) size/l (1) size/m (1) enhancement (1)

Packages

  • Total packages: 2
  • Total downloads:
    • npm 150 last-month
  • Total dependent packages: 1
    (may contain duplicates)
  • Total dependent repositories: 5
    (may contain duplicates)
  • Total versions: 23
  • Total maintainers: 3
proxy.golang.org: github.com/awslabs/fhir-works-on-aws-authz-rbac
  • Versions: 15
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.7%
Dependent repos count: 5.9%
Last synced: 6 months ago
npmjs.org: fhir-works-on-aws-authz-rbac

FHIR Works on AWS role base access control

  • Versions: 8
  • Dependent Packages: 1
  • Dependent Repositories: 5
  • Downloads: 150 Last month
Rankings
Dependent repos count: 5.1%
Forks count: 5.4%
Stargazers count: 7.7%
Average: 10.1%
Downloads: 11.2%
Dependent packages count: 21.1%
Last synced: 12 months ago

Dependencies

package.json npm
  • @types/jest ^26.0.19 development
  • @types/jsonwebtoken ^8.5.0 development
  • @types/lodash ^4.14.161 development
  • @types/node ^12 development
  • @types/shuffle-array ^1.0.0 development
  • @typescript-eslint/eslint-plugin ^4.33.0 development
  • @typescript-eslint/parser ^4.33.0 development
  • eslint ^7.32.0 development
  • eslint-config-airbnb-base ^14.2.1 development
  • eslint-config-prettier ^8.3.0 development
  • eslint-plugin-import ^2.24.2 development
  • eslint-plugin-prettier ^4.0.0 development
  • jest ^26.6.3 development
  • jest-mock-extended ^1.0.8 development
  • prettier ^2.4.1 development
  • shuffle-array ^1.0.1 development
  • standard-version ^9.3.2 development
  • ts-jest ^26.4.4 development
  • typescript ^4.1.3 development
  • fhir-works-on-aws-interface ^11.1.0
  • jsonwebtoken ^8.5.1
  • lodash ^4.17.20
yarn.lock npm
  • 742 dependencies