Skip to content
This repository has been archived by the owner on Jul 5, 2023. It is now read-only.

casbin/SummerOfCode2022

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
.gitignore
.gitignore
 
 
README.md
README.md
 
 

Repository files navigation

Google Summer Of Code 2022 for Casbin

Note: There are some significant changes in GSoC 2022 like expanding eligibility and multiple sizes of projects, see details at GSoC official site: https://opensource.googleblog.com/2021/11/expanding-google-summer-of-code-in-2022.html

What is Google Summer Of Code?

Google Summer of Code (GSoC) is a global program held by Google to bring students into open source software development. Students work with an open source organization on a 3 month programming project during their break from school. See more details at: https://summerofcode.withgoogle.com/

How we select students:

The student will be more likely selected if he/she:

  1. Contribute to Casbin related project before.
  2. Familiar with the techniques required by the idea he selected.
  3. Show the previous code related to the idea on personal website or GitHub.
  4. Provide a personal website and descriptions for previous work/projects.
  5. Provide demo sites for the previous projects if possible.
  6. Provide a resume/CV.

Get started

  1. Choose an idea from our list: https://github.com/casbin/SummerOfCode2022
  2. Send your resume/CV in PDF to: [email protected]
  3. Do a self-introduction in: https://gitter.im/casbin/gsoc
  4. Get familiar with the existing code, try to solve opened issues for your chosen idea's repo before & after application deadline.
  5. If you have questions, you can ask the mentor of the idea via GitHub or Gitter.
  6. Submit your proposal in GSoC official site. The deadline is TBD.

Ideas

Casbin Core Engine (Golang)

Description

Support more features and tune the performance in Casbin core engine. This will first be done in Golang Casbin. Possibly applied to other language implementations.

Expected outcomes

Some issues to work on:

  1. Make a Casbin middleware for go-zero: casbin/casbin#957
  2. Improve the performance of the new BatchEnforce() API: casbin/casbin#710
  3. Make a default implementation of WatcherEx: casbin/casbin#943
  4. Help solve issues for the 1st-party and 3rd-party middlewares

Skills required/preferred

  1. Golang
  2. Other languages that Casbin is written with

Mentors

Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

350 hour

Rating (Easy, Medium or Hard)

Medium

Casdoor

Description

Build a UI-first centralized authentication / Single-Sign-On (SSO) platform based on OAuth 2.0 / OIDC. It can:

  1. Use OAuth 2.0 + OIDC as the authentication protocols.
  2. Support popular 3rd-party identity providers like Google, GitHub, Facebook, etc.
  3. Has a web portal to manage users, roles and permissions.
  4. Use Casbin as authorization method.
  5. Support user register, login, password reset, 2FA like Email and SMS.

The current progress is: https://door.casdoor.com/. Source code: https://github.com/casdoor/casdoor. We want the student to continue the work.

Expected outcomes

Some issues to work on:

  1. Support SAML as IdP: casdoor/casdoor#405
  2. Support password hashing in LDAP: casdoor/casdoor#499
  3. Add Telegram provider: casdoor/casdoor#341
  4. Add Casbin model and policy management: casdoor/casdoor#95
  5. Design and develop a more beautiful frontend portal: casdoor/casdoor#69

Skills required/preferred

  1. Golang (backend)
  2. Javascript + React + Ant Design (frontend)
  3. Casbin

Mentors

Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

350 hour

Rating (Easy, Medium or Hard)

Medium

Casnode

Description

Casnode is a light-weight forum software. It is used by Casbin community as the official developer forum (https://forum.casbin.com/). We hope to fix its bugs and add more features like mailing list to replace the traditional open-source community mailing list.

The current progress is: https://github.com/casbin/casnode

Expected outcomes

Some features to add/improve:

  1. Further optimized the project UI: https://github.com/casbin/casnode/issues/400 Now casnode UI may break on some models, mainly mobile phones, we need to further optimize our project UI to fix it.
  2. Anonymous-Post Note: we may change whether to enable the node's anonymous function via the admin console.
  3. Improve the part of https://forum.casbin.com/api and https://forum.casbin.com/swagger/#/ that provides API externally.
  4. Implement notes, so users could create and publish notes: https://github.com/casbin/casnode/issues/341.
  5. Implement timeline, so users could post their thoughts and reply to others' thoughts there: https://github.com/casbin/casnode/issues/341
  6. Add RSS feed.
  7. Add some metrics, for Prometheus or others.
  8. Backup and recovery data from backup files.

Code quality maintenance:

  1. Add configurable logs. Notes: this may add a completion log system for casnode using zap.
  2. More friendly error handling instead of panic. Notes: this may be built on a well-established logging system
  3. Add some commits for code. Notes: This could be finished when you read the code.
  4. Improve performance, such as SQL query, cache, etc.

And other issues that may arise during the time.

Skills required/preferred

  1. Golang (backend)
  2. Javascript + React (frontend)
  3. Casbin

Mentors

Junjie Zhang, Casbin member, Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Easy

Casbin Dashboard

Description

Build a web UI dashboard/admin portal for Casbin & Casbin-Server.

Expected outcomes

It can:

  1. Manage models, adapters, enforcers. The adapter manager should handle different DBs.
  2. Model editor with a syntax and semantic validator.
  3. Policy editor, it should be able to handle 10,000+ more rules.
  4. A test page to make example request to Casbin and get response, like Postman. So users can test their model and policy.
  5. Authentication and authorization for the dashboard itself. Of course authorization will be implemented in Casbin (we proudly dogfood our own product :))

The current progress is: https://dashboard.casbin.com . Source code: https://github.com/casbin/casbin-dashboard. We want the student to continue the work.

Skills required/preferred

  1. Golang (backend)
  2. Javascript + React + Ant Design (frontend)
  3. Casbin

Mentors

Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Easy

Casbin for C/C++

Description

Casbin-CPP provides various models for advanced authorization solutions in C++. It currently supports all the major OS's including Windows, Linux and macOS. casbin-cpp has seen a major revamp to make the library as functional as its Golang counterparts. This project uses CMake for building, packaging, and installation, and CTest for testing. Apart from that, casbin-cpp supports python bindings through pybind11.

The current progress is: https://github.com/casbin/casbin-cpp

Expected outcomes

Here is a list of tasks we're looking forward to work on this summer on a priority basis:

  • casbin-cpp#79: Developing authz middlewares for other C++ projects like Mosquitto.
  • casbin-cpp#115: Developing authz middleware for Envoy proxy.
  • casbin-cpp#100: Various features of Casbin-CPP can be used in Glewlwyd, a C++ based server. We need to investigate and try to integrate casbin-cpp into Glewlwyd.
  • casbin-cpp#190: Unit testing and benchmarking for multithreaded workloads is in backlog and needs to be investigated thoroughly.

Skills required/preferred

  1. C++
  2. Golang (only need to read code)
  3. CMake
  4. Python

Mentors

Yash Pandey, Casbin member, Joey Xie, Casbin member, Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Hard

Casbin for Java

Description

jCasbin needs to be kept in sync with the features of casbin-golang at all times. For example, the special syntax of in, the update of the role manager, etc. At the same time, it is also necessary to maintain and integrate the unique ecology of Java, such as casbin-spring-boot-starter and Play middleware, etc. Performance is also a point of great concern, so benchmark needs to be done.

Expected outcomes

  1. More features support
  • Reimplement the role manager: jcasbin#261
  • Sync more features about "in" special grammar from Go-Casbin: special-grammer
  • Make a default implementation of WatcherEx and migrate Watcher to WatcherEx : Default implementation of WatcherEx casbin#943
  • Fix the bug about ClassCastException for Strings within grouping fucntions: ClassCastException for Strings within grouping fucntions jcasbin#254
  1. Continuous maintenance of the surrounding ecology
  • Optimize casbin-spring-boot-starter and other middlewares dependencies. casbin-spring-boot-starter
  • Provide more offical adapter/watcher like Golang: watchers
  • Make a Play Framework middleware: Create a jCasbin authorization module for Play jcasbin#104
  • Help solve issues for the 1st-party and 3rd-party middlewares.
  1. Benchmark and performance optimization
  • Benchmarking jCasbin and the integrations with main middlewares.
  • Find and resolve performance bottlenecks.
  • Explore the alternative in large-scale scenarios

Skills required/preferred

  1. Java
  2. Other languages that Casbin is written with

Mentors

Yang Tang, Casbin member, Zhengjin Fang, Casbin member, Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Medium

Casbin for .NET

Description

Casbin.NET v2 will release quickly. The new architecture provides excellent performance and flexible scalability and prepares for the addition of more imaginative and exciting features.

Expected outcomes

  1. Support more features:
  1. Enhance ecosystem:
  • a. Support ASP.NET Core and Blazor (Enhance Casbin.AspNetCore)
  • b. Provide Offical Redis adaptor/watcher.

Requirements

  1. .NET/C#
  2. ASP.NET Core

Mentors

Sagilio, Casbin member

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Medium

Casdoor for .NET

Description

Casdoor is a UI-first centralized authentication / Single-Sign-On (SSO) platform based on OAuth 2.0 / OIDC. We hope to provide a comprehensive and powerful SDK to make .NET application integrate with it easily.

Expected outcomes

  1. Implement SDK:
  • a. Implement Casdoor.Client to call Casdoor APIs easily.
  • b. Implement Casdoor.AspNetCore to integrate ASP.NET Core with Casdoor.
  • c. Implement Casdoor.Native to integrate WPF or Maui with Casdoor
  1. Implement Samples:
  • a. Provide ASP.NET Core Web API, MVC and Blazor samples with the SDK.
  • b. Provide WPF or Maui smaples with the SDK.

Requirements

  1. .NET/C#
  2. ASP.NET Core
  3. WPF or Maui

Mentors

Sagilio, Casbin member

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Medium

Casbin Sam

Description

An authorization service based on OAuth 2.x and support centralized authentication / Single-Sign-On (SSO) integration. It can:

Expected outcomes

  1. Use Casbin.NET and Casbin.AspNetCore to authorizate.
  2. Provide Web APIs to manage users, roles and permissions.
  3. Support integrate OIDC authentication provider (Identity Server 4) and ASP.NET Identity to manage user and sgin in/out.
  4. Support be integrated to Dapr or Steeltoe as authentication/authorization provider.

The current progress is: https://github.com/casbin-net/casbin-sam. We want the student to continue the work.

Requirements

  1. .NET/C#
  2. Casbin.NET and Casbin.AspNetCore
  3. Dapr or Steeltoe

Mentors

Sagilio, Casbin member, Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Medium

Casbin for Cloud Native

Description

Currently, Casbin has limited adaptability in the cloud-native field. We hope to use kubebuilder 3.x to refact the k8s-authz and provide CRD based model and policy management. Enhance model parse to compatible with k8s better.

Expected outcomes

  1. Refact k8s-authz
  • a. Porvide predefined r or p tokens and custom function for k8s.
  • b. Provide CRD based model and policy management.
  • c. Provide Client and helm integration.
  • d. Make kubesphere-athz compatible with the new k8s-authz.
  • e. Improve test coverage for the new k8s-authz and envoy-authz.
  1. Enhance ecosystem:
  • a. Implement Casbin middleware for Dapr
  • b. Explore more usage scenarios on Cloud Native.

Requirements

  1. Golang
  2. K8s (kubebuilder) and Cloud Native
  3. Service Mesh and Dapr

Mentors

Sagilio, Casbin member, Ashish, Casbin member, Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

350 hour

Rating (Easy, Medium or Hard)

Hard

Casbin for Rust

Description

With Casbin community's effort, the Rust version of Casbin is now mature and ready for production. Casbin-RS can provide access control with blazing fast speed.

Expected outcomes

There are something need to be implemented，from easy to hard:

  1. Embrace Rust 2021 edition [Easy]
  • Complete the migration from edition 2018 to edition 2021.
  • Clean up stale and meaningless dependencies and make clippy happy.

Note This work will help you get familiar with the Rust toolchain and the existing work of Casbin-RS, so please complete it for at least two repos.

  1. Continuous maintenance of the surrounding ecology [Medium]
  • Implement a middleware for Poem with examples.
  • An article introducing how to use casbin-rs with poem.
  • Participate in the maintenance of at least one other repo, such as sqlx-adapter or casbin-grpc.

Note This work will help you understand the mechanics of casbin's operation. In addition, we hope you can present your works, which will become an important milestone for you in the casbin community.

  1. Explore casbin-rs in real-world/distributed applications [Hard]
  • You can choose to:
    • Implement a real-world application with casbin-rs, Or
    • Implementing openraft-based distributed casbin clusters/plugins.
  • An article that describes your current work.

Note Go beyond the existing casbin-rs projects, this is a job that is completely led by you. casbin-grpc and casbin-raft are the results of some previous explorations.

Skills required/preferred

  1. Rust
  2. Other languages that Casbin is written with

Mentors

Chojan Shang, Casbin member, Yisheng Chai, Casbin member, Cheng JIANG, Casbin member, Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Hard

Casbin for Node.js

Description

Improving the user experience of Node-Casbin will be our focus.

Expected outcomes

Some issues to work on:

Skills required/preferred

  1. JavaScript (Node.js/TypeScript)
  2. Other languages that Casbin is written with

Mentors

Zixuan Liu, Casbin member

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Medium

Casbin Hub

Casbin Hub is similar to Docker Hub website, which is mainly used to share and discuss the model and policy of Casbin.

Expected outcomes

We need to implement the following features:

  1. Support anyone to share the model and policy of Casbin. Sharers must describe the scenario that this model applies, and mark the classification, like so: Frontend, Backend, Cloud, Message System, and so on. Users can discuss shared content.

  2. Integrate the Casbin-Online-Editor is used to test or debug the model and policy shared by users.

Skills required/preferred

  1. Golang (Backend)
  2. React (Frontend)
  3. Casbin

Mentors

Zixuan Liu, Casbin member, Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Medium

Casbin for PHP

Description

PHP-Casbin An authorization library that supports access control models like ACL, RBAC, ABAC in PHP .

Expected outcomes

  1. Add AddPermissionsForUser API.
  2. Add cache for g function, refer to: https://github.com/casbin/casbin/blob/master/util/builtin_operators.go#L333.
  3. Integrate laravel's Gates in Laravel-Authz.
  4. Implementation of WatcherEx, basic Watcher: Swoole Redis watcher Workerman Redis watcher.
  5. Implement propel-adapter, Propel is a highly customizable and blazing fast ORM library for PHP.
  6. Consistent with the functionality of Casbin Core Engine (Golang).
  7. Bug fixes in issues, improve some extensions.

Skills required/preferred

  1. PHP
  2. Casbin

Mentors

Jon Lee, Casbin member

Expected size of project (175 hour or 350 hour)

350 hour

Rating (Easy, Medium or Hard)

Medium

Casbin for Python

Description

  1. At present, compared to Casbin for Golang, Pycasbin is not very perfect, especially the lack of RBAC API, so we hope that Pycasbin can fully implement the function of Casbin (Go).
  2. PyCasbin's adaptation to various frameworks, such as Django, Tornado, etc.

Pycasbin organization: https://github.com/pycasbin

Expected outcomes

  1. Implement redis-adapter.
  2. Implement etcd-adapter.
  3. Improve performance for enforce().
  4. Complete implementation of PyCasbin-on-CPP.
  5. Reimplement the implementation of Pycasbin in Django, introduce Django's Middleware, Caching, Logging, and integrate the Django authentication system, and existing plugins: django-casbin django-orm-adapter.

Some issues to work on: https://github.com/casbin/pycasbin/issues

Skills required/preferred

  1. Python
  2. Other languages that Casbin is written with

Mentors

Jon Lee, Casbin member

Expected size of project (175 hour or 350 hour)

350 hour

Rating (Easy, Medium or Hard)

Medium

Casbin.js

Description

Quite a lot of users want to use Casbin to control web frontend UI elements, like:

  1. Some tabs are only visible to admin users.
  2. Some buttons should be grayed-out for users with no permission to click them.
  3. A list can only show filtered items based on a user's permission rights.

Over time we have made node-casbin a cross-platform Javascript permission control library and have called the new library casbin.js. The next step is to refactor node-casbin to a casbin.js-based wrapper. Another possible idea is create a browser-casbin for front-end developers with front-end friendly api.

The current progress is: https://github.com/casbin/casbin.js

Currently, we still lack the middlewares for Angular, React and Vue. These new JS frameworks are very popular and making middlewares for them will boost our usage from their population.

Expected outcomes

  1. Sync progress with node-casbin
  2. Update vue-authz and react-authz to new casbin.js.
  3. Refactor node-casbin to casbin.js wrapper.

Skills required/preferred

  1. Typescript
  2. Node-Casbin
  3. Vue or React development experience
  4. At least one backend language like Golang

Mentors

Xinyu Zhou, Casbin member, Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

350 hour

Rating (Easy, Medium or Hard)

Hard

Casbin for Lua

Description

Port Golang Casbin into Lua. We call it lua-casbin. It should work on the Nginx + OpenResty stack. Most of Casbin's functionalities (for example 90%) should work.

Nginx is now the most popular HTTP server in the world. OpenResty is a web platform based on Nginx which can run Lua scripts using its LuaJIT engine. Nginx + OpenResty are usually used in edge computing and authorization is a real need for its scenario. Lua-Casbin will help Nginx and OpenResty users on checking permissions of the coming HTTP request.

The current progress is: https://github.com/casbin/lua-casbin

Expected outcomes

  1. Implementation of Watcher, Watcher ensures policy consistency in multiple Casbin instances.
  2. Add cache for g function, refer to: https://github.com/casbin/casbin/blob/master/util/builtin_operators.go#L333.
  3. Add AddPermissionsForUser API.
  4. Add LoadPolicyArray() to load policy from array
  5. Improve performance for enforce().
  6. Implement the built-in function keyMatch5.
  7. Fixes and refinements to lua-casbin's extensions.

Skills required/preferred

  1. Nginx
  2. OpenResty
  3. Lua
  4. Golang (only need to read code)

Mentors

Jon Lee, Casbin member, Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Medium

Casbin for Dart

Description

Port Casbin to Dart, little progress has been made in the project so it's excellent for jumping in early.

The current progress is: https://github.com/casbin/dart-casbin

Expected outcomes

You will be responsible for the design and making of the Dart port with the help of the mentor, most of Casbin's functionalities should work.

Skills required/preferred

  1. Dart
  2. Other languages that Casbin is written with.

Mentors

Tomás Arias, Casbin member

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Medium

Casbin for Swift

Description

We already have a Swift version Casbin called SwiftCasbin. It already works on all primary OSs, like Windows, Linux, macOS,iOS,tvOS,watchOS. Most of Casbin's functionalities (for example 90%) should work.

The current progress is: https://github.com/casbin/SwiftCasbin

Expected outcomes

There are still many bugs and missing features in SwiftCasbin. Moreover, we also need to make authz middlewares for any Swift projects:

  1. Server-Side like Vapor and adapters for DB.
  2. A frontend developer friendly API for UI frameworks like UIKit,SwiftUI.

Skills required/preferred

  1. Swift
  2. Golang (only need to read code)
  3. ios UIkit SwiftUI

Mentors

Xiaobei, Casbin member, Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

175 hour

Rating (Easy, Medium or Hard)

Medium

Casbin Mesh

Description

Last summer, we started a new project called Casbin-Mesh which allows us to deploy the Casbin to many nodes using the raft consensus algorithm to handle rapidly increasing data, which raises the throughout of read-only transactions.

The current progress is: https://github.com/casbin/casbin-mesh

Expected outcomes

However, there are still many works that need to be done.

  1. The bottleneck of memory data structure
  • Reconstruction the memory data model
    • We are going to use the buffer pool manager handling very large data that over then RAM
  1. Avoiding full-table scanning
  • Indexes
    • Create indexes for all policies
    • Use Indexes to avoid full-table scanning
  • Basic query optimization
  1. Transaction Implementations

Skills required/preferred

  1. Golang
  2. At least you need to be familiar with the basic concepts of the query optimization, indexing (hash index, B+ tree index), multi-version concurrency control.
  3. (preferred) Had taken database lectures (Such as CMU 15-445 etc.)

Mentors

WenyXu, Casbin member, Yang Luo, Casbin founder

Expected size of project (175 hour or 350 hour)

350 hour

Rating (Easy, Medium or Hard)

Hard

About

GSoC 2022 Idea List for Casbin

summerofcode.withgoogle.com/programs/2022/organizations/casbin

Topics

gsoc casbin gsoc-2022

Resources

Readme
Activity
Custom properties

Stars

24 stars

Watchers

3 watching

Forks

11 forks
Report repository

Releases

No releases published

Sponsor this project

 
Learn more about GitHub Sponsors

Packages

No packages published

Contributors 13