authloom 0.1.0a1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- authloom/__init__.py +8 -0
- authloom/db/__init__.py +8 -0
- authloom/db/schema.py +47 -0
- authloom/db/utils/__init__.py +0 -0
- authloom/db/utils/time.py +30 -0
- authloom/dtos.py +72 -0
- authloom/exceptions.py +25 -0
- authloom/py.typed +0 -0
- authloom/router.py +118 -0
- authloom/service.py +237 -0
- authloom/settings.py +64 -0
- authloom-0.1.0a1.dist-info/METADATA +238 -0
- authloom-0.1.0a1.dist-info/RECORD +15 -0
- authloom-0.1.0a1.dist-info/WHEEL +4 -0
- authloom-0.1.0a1.dist-info/licenses/LICENSE +202 -0
authloom/__init__.py
ADDED
authloom/db/__init__.py
ADDED
authloom/db/schema.py
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
from cuid2 import cuid_wrapper
|
|
2
|
+
from sqlalchemy import VARCHAR, ForeignKey, func
|
|
3
|
+
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
|
|
4
|
+
|
|
5
|
+
from authloom.db.utils.time import UTCDateTime, utc_now
|
|
6
|
+
|
|
7
|
+
CUID_GENERATOR = cuid_wrapper()
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class Base(DeclarativeBase):
|
|
11
|
+
pass
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class User(Base):
|
|
15
|
+
__tablename__ = "authloom_users"
|
|
16
|
+
|
|
17
|
+
id = mapped_column(VARCHAR, primary_key=True, default=CUID_GENERATOR)
|
|
18
|
+
name = mapped_column(VARCHAR, index=True, nullable=False)
|
|
19
|
+
email = mapped_column(VARCHAR, unique=True, index=True, nullable=False)
|
|
20
|
+
password = mapped_column(VARCHAR, deferred=True, nullable=False)
|
|
21
|
+
created_at = mapped_column(
|
|
22
|
+
UTCDateTime(), nullable=False, default=utc_now, server_default=func.now()
|
|
23
|
+
)
|
|
24
|
+
updated_at = mapped_column(
|
|
25
|
+
UTCDateTime(), default=utc_now, server_default=func.now(), onupdate=utc_now
|
|
26
|
+
)
|
|
27
|
+
|
|
28
|
+
sessions: Mapped[list["Session"]] = relationship(
|
|
29
|
+
back_populates="user", cascade="all, delete-orphan"
|
|
30
|
+
)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
class Session(Base):
|
|
34
|
+
__tablename__ = "authloom_sessions"
|
|
35
|
+
|
|
36
|
+
id = mapped_column(VARCHAR, primary_key=True, default=CUID_GENERATOR)
|
|
37
|
+
token_hash = mapped_column(VARCHAR(64), unique=True, index=True, nullable=False)
|
|
38
|
+
expires_at = mapped_column(UTCDateTime(), nullable=False)
|
|
39
|
+
revoked_at = mapped_column(UTCDateTime(), nullable=True)
|
|
40
|
+
created_at = mapped_column(
|
|
41
|
+
UTCDateTime(), nullable=False, default=utc_now, server_default=func.now()
|
|
42
|
+
)
|
|
43
|
+
|
|
44
|
+
user_id = mapped_column(
|
|
45
|
+
ForeignKey("authloom_users.id", ondelete="CASCADE"), index=True, nullable=False
|
|
46
|
+
)
|
|
47
|
+
user: Mapped["User"] = relationship(back_populates="sessions")
|
|
File without changes
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
from datetime import UTC, datetime
|
|
2
|
+
|
|
3
|
+
from sqlalchemy import DateTime, TypeDecorator
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
def utc_now() -> datetime:
|
|
7
|
+
return datetime.now(UTC)
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class UTCDateTime(TypeDecorator[datetime]):
|
|
11
|
+
impl = DateTime
|
|
12
|
+
cache_ok = True
|
|
13
|
+
|
|
14
|
+
def process_bind_param(self, value: datetime | None, dialect) -> datetime | None:
|
|
15
|
+
if value is None:
|
|
16
|
+
return None
|
|
17
|
+
|
|
18
|
+
if value.tzinfo is None or value.tzinfo.utcoffset(value) is None:
|
|
19
|
+
raise ValueError("UTCDateTime only accepts timezone-aware datetimes")
|
|
20
|
+
|
|
21
|
+
return value.astimezone(UTC).replace(tzinfo=None)
|
|
22
|
+
|
|
23
|
+
def process_result_value(self, value: datetime | None, dialect) -> datetime | None:
|
|
24
|
+
if value is None:
|
|
25
|
+
return None
|
|
26
|
+
|
|
27
|
+
if value.tzinfo is None or value.tzinfo.utcoffset(value) is None:
|
|
28
|
+
return value.replace(tzinfo=UTC)
|
|
29
|
+
|
|
30
|
+
return value.astimezone(UTC)
|
authloom/dtos.py
ADDED
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import unicodedata
|
|
2
|
+
from datetime import datetime
|
|
3
|
+
from typing import Self
|
|
4
|
+
|
|
5
|
+
from pydantic import (
|
|
6
|
+
BaseModel,
|
|
7
|
+
ConfigDict,
|
|
8
|
+
EmailStr,
|
|
9
|
+
field_validator,
|
|
10
|
+
model_validator,
|
|
11
|
+
)
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class UserResDto(BaseModel):
|
|
15
|
+
id: str
|
|
16
|
+
name: str
|
|
17
|
+
email: EmailStr
|
|
18
|
+
created_at: datetime
|
|
19
|
+
updated_at: datetime
|
|
20
|
+
|
|
21
|
+
model_config = ConfigDict(from_attributes=True)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
class SignupHttpReqDto(BaseModel):
|
|
25
|
+
name: str
|
|
26
|
+
email: EmailStr
|
|
27
|
+
password: str
|
|
28
|
+
password_confirm: str
|
|
29
|
+
|
|
30
|
+
@model_validator(mode="after")
|
|
31
|
+
def passwords_match(self) -> Self:
|
|
32
|
+
if self.password != self.password_confirm:
|
|
33
|
+
raise ValueError("passwords do not match")
|
|
34
|
+
|
|
35
|
+
return self
|
|
36
|
+
|
|
37
|
+
@field_validator("password", "password_confirm")
|
|
38
|
+
@classmethod
|
|
39
|
+
def normalize_password(cls, v: str) -> str:
|
|
40
|
+
return unicodedata.normalize("NFC", v)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
class SigninHttpReqDto(BaseModel):
|
|
44
|
+
email: EmailStr
|
|
45
|
+
password: str
|
|
46
|
+
|
|
47
|
+
@field_validator("password")
|
|
48
|
+
@classmethod
|
|
49
|
+
def normalize_password(cls, v: str) -> str:
|
|
50
|
+
return unicodedata.normalize("NFC", v)
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
class AuthHttpResDto(BaseModel):
|
|
54
|
+
message: str
|
|
55
|
+
user: UserResDto
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
class SignupSrvInputDto(BaseModel):
|
|
59
|
+
name: str
|
|
60
|
+
email: EmailStr
|
|
61
|
+
password: str
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
class SigninSrvInputDto(BaseModel):
|
|
65
|
+
email: EmailStr
|
|
66
|
+
password: str
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
class SessionResDto(BaseModel):
|
|
70
|
+
id: str
|
|
71
|
+
token_raw: str
|
|
72
|
+
expires_at: datetime
|
authloom/exceptions.py
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
from enum import StrEnum
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
class UserAlreadyExistsException(Exception):
|
|
5
|
+
pass
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class InvalidCredentialsException(Exception):
|
|
9
|
+
pass
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class SessionCreationException(Exception):
|
|
13
|
+
pass
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
class PasswordPolicyCode(StrEnum):
|
|
17
|
+
TOO_SHORT = "password_too_short"
|
|
18
|
+
TOO_LONG = "password_too_long"
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
class PasswordPolicyException(Exception):
|
|
22
|
+
def __init__(self, code: PasswordPolicyCode, message: str) -> None:
|
|
23
|
+
self.code = code
|
|
24
|
+
self.message = message
|
|
25
|
+
super().__init__(message)
|
authloom/py.typed
ADDED
|
File without changes
|
authloom/router.py
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
from typing import Annotated
|
|
2
|
+
|
|
3
|
+
from fastapi import APIRouter, Depends, HTTPException, Request, Response, status
|
|
4
|
+
|
|
5
|
+
from authloom.db.schema import User
|
|
6
|
+
from authloom.dtos import (
|
|
7
|
+
AuthHttpResDto,
|
|
8
|
+
SigninHttpReqDto,
|
|
9
|
+
SigninSrvInputDto,
|
|
10
|
+
SignupHttpReqDto,
|
|
11
|
+
SignupSrvInputDto,
|
|
12
|
+
UserResDto,
|
|
13
|
+
)
|
|
14
|
+
from authloom.exceptions import (
|
|
15
|
+
InvalidCredentialsException,
|
|
16
|
+
PasswordPolicyException,
|
|
17
|
+
SessionCreationException,
|
|
18
|
+
UserAlreadyExistsException,
|
|
19
|
+
)
|
|
20
|
+
from authloom.service import AuthLoom
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
def create_auth_router(auth: AuthLoom) -> APIRouter:
|
|
24
|
+
router = APIRouter(prefix="/auth", tags=["AuthLoom"])
|
|
25
|
+
|
|
26
|
+
@router.post(
|
|
27
|
+
"/signup", status_code=status.HTTP_201_CREATED, response_model=AuthHttpResDto
|
|
28
|
+
)
|
|
29
|
+
async def signup(input: SignupHttpReqDto, response: Response):
|
|
30
|
+
try:
|
|
31
|
+
user, session = await auth.signup(
|
|
32
|
+
input=SignupSrvInputDto(**input.model_dump())
|
|
33
|
+
)
|
|
34
|
+
response.set_cookie(
|
|
35
|
+
key=auth.config.cookie_session.cookie_name,
|
|
36
|
+
value=session.token_raw,
|
|
37
|
+
httponly=auth.config.cookie_session.http_only,
|
|
38
|
+
expires=session.expires_at,
|
|
39
|
+
domain=auth.config.cookie_session.domain,
|
|
40
|
+
path=auth.config.cookie_session.path,
|
|
41
|
+
samesite=auth.config.cookie_session.samesite,
|
|
42
|
+
secure=auth.config.cookie_session.secure,
|
|
43
|
+
)
|
|
44
|
+
return AuthHttpResDto(message="account created successfully", user=user)
|
|
45
|
+
except PasswordPolicyException as exc:
|
|
46
|
+
raise HTTPException(
|
|
47
|
+
status_code=status.HTTP_422_UNPROCESSABLE_CONTENT,
|
|
48
|
+
detail={
|
|
49
|
+
"code": exc.code,
|
|
50
|
+
"message": exc.message,
|
|
51
|
+
},
|
|
52
|
+
) from exc
|
|
53
|
+
except UserAlreadyExistsException as exc:
|
|
54
|
+
raise HTTPException(
|
|
55
|
+
status_code=status.HTTP_409_CONFLICT,
|
|
56
|
+
detail="user with this email already exists",
|
|
57
|
+
) from exc
|
|
58
|
+
except SessionCreationException as exc:
|
|
59
|
+
raise HTTPException(
|
|
60
|
+
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
61
|
+
detail="could not create session",
|
|
62
|
+
) from exc
|
|
63
|
+
|
|
64
|
+
@router.post(
|
|
65
|
+
"/signin", status_code=status.HTTP_200_OK, response_model=AuthHttpResDto
|
|
66
|
+
)
|
|
67
|
+
async def signin(input: SigninHttpReqDto, response: Response):
|
|
68
|
+
try:
|
|
69
|
+
user, session = await auth.signin(
|
|
70
|
+
input=SigninSrvInputDto(**input.model_dump())
|
|
71
|
+
)
|
|
72
|
+
except InvalidCredentialsException as exc:
|
|
73
|
+
raise HTTPException(
|
|
74
|
+
status_code=status.HTTP_401_UNAUTHORIZED,
|
|
75
|
+
detail="invalid credentials",
|
|
76
|
+
) from exc
|
|
77
|
+
except SessionCreationException as exc:
|
|
78
|
+
raise HTTPException(
|
|
79
|
+
status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
|
|
80
|
+
detail="could not create session",
|
|
81
|
+
) from exc
|
|
82
|
+
|
|
83
|
+
response.set_cookie(
|
|
84
|
+
key=auth.config.cookie_session.cookie_name,
|
|
85
|
+
value=session.token_raw,
|
|
86
|
+
httponly=auth.config.cookie_session.http_only,
|
|
87
|
+
expires=session.expires_at,
|
|
88
|
+
domain=auth.config.cookie_session.domain,
|
|
89
|
+
path=auth.config.cookie_session.path,
|
|
90
|
+
samesite=auth.config.cookie_session.samesite,
|
|
91
|
+
secure=auth.config.cookie_session.secure,
|
|
92
|
+
)
|
|
93
|
+
return AuthHttpResDto(message="logged in successfully", user=user)
|
|
94
|
+
|
|
95
|
+
@router.post("/signout", status_code=status.HTTP_204_NO_CONTENT)
|
|
96
|
+
async def signout(request: Request, response: Response):
|
|
97
|
+
token_raw = request.cookies.get(auth.config.cookie_session.cookie_name)
|
|
98
|
+
if not token_raw:
|
|
99
|
+
return None
|
|
100
|
+
|
|
101
|
+
await auth.signout(token_raw=token_raw)
|
|
102
|
+
|
|
103
|
+
response.delete_cookie(
|
|
104
|
+
key=auth.config.cookie_session.cookie_name,
|
|
105
|
+
httponly=auth.config.cookie_session.http_only,
|
|
106
|
+
domain=auth.config.cookie_session.domain,
|
|
107
|
+
path=auth.config.cookie_session.path,
|
|
108
|
+
samesite=auth.config.cookie_session.samesite,
|
|
109
|
+
secure=auth.config.cookie_session.secure,
|
|
110
|
+
)
|
|
111
|
+
|
|
112
|
+
@router.get("/me", status_code=status.HTTP_200_OK)
|
|
113
|
+
async def get_current_user(
|
|
114
|
+
user: Annotated[User, Depends(auth.require_current_user)],
|
|
115
|
+
):
|
|
116
|
+
return UserResDto.model_validate(user)
|
|
117
|
+
|
|
118
|
+
return router
|
authloom/service.py
ADDED
|
@@ -0,0 +1,237 @@
|
|
|
1
|
+
import hashlib
|
|
2
|
+
import secrets
|
|
3
|
+
from datetime import timedelta
|
|
4
|
+
|
|
5
|
+
import email_normalize
|
|
6
|
+
from argon2 import PasswordHasher
|
|
7
|
+
from argon2.exceptions import VerifyMismatchError
|
|
8
|
+
from fastapi import HTTPException, Request, status
|
|
9
|
+
from sqlalchemy import select
|
|
10
|
+
from sqlalchemy.exc import IntegrityError
|
|
11
|
+
from sqlalchemy.orm import undefer
|
|
12
|
+
|
|
13
|
+
from authloom.db.schema import Session, User
|
|
14
|
+
from authloom.db.utils.time import utc_now
|
|
15
|
+
from authloom.dtos import (
|
|
16
|
+
SessionResDto,
|
|
17
|
+
SigninSrvInputDto,
|
|
18
|
+
SignupSrvInputDto,
|
|
19
|
+
UserResDto,
|
|
20
|
+
)
|
|
21
|
+
from authloom.exceptions import (
|
|
22
|
+
InvalidCredentialsException,
|
|
23
|
+
PasswordPolicyCode,
|
|
24
|
+
PasswordPolicyException,
|
|
25
|
+
SessionCreationException,
|
|
26
|
+
UserAlreadyExistsException,
|
|
27
|
+
)
|
|
28
|
+
from authloom.settings import AuthLoomConfig
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
def hash_session_token(token_raw: str) -> str:
|
|
32
|
+
return hashlib.sha256(token_raw.encode("utf-8")).hexdigest()
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
def generate_session_token() -> tuple[str, str]:
|
|
36
|
+
token = secrets.token_urlsafe(32)
|
|
37
|
+
return token, hash_session_token(token)
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
class AuthLoom:
|
|
41
|
+
def __init__(self, config: AuthLoomConfig) -> None:
|
|
42
|
+
self.config = config
|
|
43
|
+
self.password_hasher = PasswordHasher()
|
|
44
|
+
self.session_factory = config.session_factory
|
|
45
|
+
|
|
46
|
+
async def require_current_user(self, request: Request) -> User:
|
|
47
|
+
token_raw = request.cookies.get(self.config.cookie_session.cookie_name)
|
|
48
|
+
if not token_raw:
|
|
49
|
+
raise HTTPException(
|
|
50
|
+
status_code=status.HTTP_401_UNAUTHORIZED,
|
|
51
|
+
detail="you are not logged in",
|
|
52
|
+
)
|
|
53
|
+
|
|
54
|
+
user = await self.get_current_user(token_raw=token_raw)
|
|
55
|
+
if user is None:
|
|
56
|
+
raise HTTPException(
|
|
57
|
+
status_code=status.HTTP_401_UNAUTHORIZED,
|
|
58
|
+
detail="you are not logged in",
|
|
59
|
+
)
|
|
60
|
+
|
|
61
|
+
return user
|
|
62
|
+
|
|
63
|
+
async def optional_current_user(self, request: Request) -> User | None:
|
|
64
|
+
token_raw = request.cookies.get(self.config.cookie_session.cookie_name)
|
|
65
|
+
if not token_raw:
|
|
66
|
+
return None
|
|
67
|
+
|
|
68
|
+
return await self.get_current_user(token_raw=token_raw)
|
|
69
|
+
|
|
70
|
+
async def signup(
|
|
71
|
+
self, input: SignupSrvInputDto
|
|
72
|
+
) -> tuple[UserResDto, SessionResDto]:
|
|
73
|
+
if len(input.password) < self.config.password_config.min_length:
|
|
74
|
+
raise PasswordPolicyException(
|
|
75
|
+
code=PasswordPolicyCode.TOO_SHORT,
|
|
76
|
+
message=(
|
|
77
|
+
f"Password must contains at least "
|
|
78
|
+
f"{self.config.password_config.min_length} characters."
|
|
79
|
+
),
|
|
80
|
+
)
|
|
81
|
+
|
|
82
|
+
if len(input.password) > self.config.password_config.max_length:
|
|
83
|
+
raise PasswordPolicyException(
|
|
84
|
+
code=PasswordPolicyCode.TOO_LONG,
|
|
85
|
+
message=(
|
|
86
|
+
f"Password must contains at most "
|
|
87
|
+
f"{self.config.password_config.max_length} characters."
|
|
88
|
+
),
|
|
89
|
+
)
|
|
90
|
+
|
|
91
|
+
email_normalizer = email_normalize.Normalizer()
|
|
92
|
+
normalized_result = await email_normalizer.normalize(input.email)
|
|
93
|
+
|
|
94
|
+
async with self.session_factory() as session:
|
|
95
|
+
q = await session.execute(
|
|
96
|
+
select(User)
|
|
97
|
+
.where(User.email == normalized_result.normalized_address)
|
|
98
|
+
.limit(1)
|
|
99
|
+
)
|
|
100
|
+
user = q.scalar_one_or_none()
|
|
101
|
+
|
|
102
|
+
if user:
|
|
103
|
+
raise UserAlreadyExistsException()
|
|
104
|
+
|
|
105
|
+
hashed_password = self.password_hasher.hash(input.password)
|
|
106
|
+
|
|
107
|
+
user = User(
|
|
108
|
+
name=input.name,
|
|
109
|
+
email=normalized_result.normalized_address,
|
|
110
|
+
password=hashed_password,
|
|
111
|
+
)
|
|
112
|
+
|
|
113
|
+
session.add(user)
|
|
114
|
+
try:
|
|
115
|
+
await session.flush()
|
|
116
|
+
except IntegrityError:
|
|
117
|
+
await session.rollback()
|
|
118
|
+
raise UserAlreadyExistsException() from None
|
|
119
|
+
|
|
120
|
+
token_raw, token_hash = generate_session_token()
|
|
121
|
+
auth_session = Session(
|
|
122
|
+
token_hash=token_hash,
|
|
123
|
+
user_id=user.id,
|
|
124
|
+
expires_at=utc_now()
|
|
125
|
+
+ timedelta(seconds=self.config.cookie_session.ttl),
|
|
126
|
+
)
|
|
127
|
+
|
|
128
|
+
session.add(auth_session)
|
|
129
|
+
|
|
130
|
+
try:
|
|
131
|
+
await session.commit()
|
|
132
|
+
except IntegrityError:
|
|
133
|
+
await session.rollback()
|
|
134
|
+
raise SessionCreationException() from None
|
|
135
|
+
|
|
136
|
+
await session.refresh(user)
|
|
137
|
+
await session.refresh(auth_session)
|
|
138
|
+
|
|
139
|
+
return UserResDto.model_validate(user), SessionResDto(
|
|
140
|
+
id=auth_session.id,
|
|
141
|
+
token_raw=token_raw,
|
|
142
|
+
expires_at=auth_session.expires_at,
|
|
143
|
+
)
|
|
144
|
+
|
|
145
|
+
async def signin(
|
|
146
|
+
self, input: SigninSrvInputDto
|
|
147
|
+
) -> tuple[UserResDto, SessionResDto]:
|
|
148
|
+
if len(input.password) > self.config.password_config.max_length:
|
|
149
|
+
raise InvalidCredentialsException()
|
|
150
|
+
|
|
151
|
+
email_normalizer = email_normalize.Normalizer()
|
|
152
|
+
normalized_result = await email_normalizer.normalize(input.email)
|
|
153
|
+
|
|
154
|
+
async with self.session_factory() as session:
|
|
155
|
+
q = await session.execute(
|
|
156
|
+
select(User)
|
|
157
|
+
.options(undefer(User.password))
|
|
158
|
+
.where(User.email == normalized_result.normalized_address)
|
|
159
|
+
.limit(1)
|
|
160
|
+
)
|
|
161
|
+
user = q.scalar_one_or_none()
|
|
162
|
+
|
|
163
|
+
if user is None:
|
|
164
|
+
raise InvalidCredentialsException()
|
|
165
|
+
|
|
166
|
+
try:
|
|
167
|
+
self.password_hasher.verify(user.password, input.password)
|
|
168
|
+
except VerifyMismatchError:
|
|
169
|
+
raise InvalidCredentialsException() from None
|
|
170
|
+
|
|
171
|
+
token_raw, token_hash = generate_session_token()
|
|
172
|
+
auth_session = Session(
|
|
173
|
+
token_hash=token_hash,
|
|
174
|
+
user_id=user.id,
|
|
175
|
+
expires_at=utc_now()
|
|
176
|
+
+ timedelta(seconds=self.config.cookie_session.ttl),
|
|
177
|
+
)
|
|
178
|
+
session.add(auth_session)
|
|
179
|
+
|
|
180
|
+
try:
|
|
181
|
+
await session.commit()
|
|
182
|
+
except IntegrityError:
|
|
183
|
+
await session.rollback()
|
|
184
|
+
raise SessionCreationException() from None
|
|
185
|
+
|
|
186
|
+
await session.refresh(auth_session)
|
|
187
|
+
|
|
188
|
+
return UserResDto.model_validate(user), SessionResDto(
|
|
189
|
+
id=auth_session.id,
|
|
190
|
+
token_raw=token_raw,
|
|
191
|
+
expires_at=auth_session.expires_at,
|
|
192
|
+
)
|
|
193
|
+
|
|
194
|
+
async def signout(self, token_raw: str) -> None:
|
|
195
|
+
token_hash = hash_session_token(token_raw)
|
|
196
|
+
|
|
197
|
+
async with self.session_factory() as session:
|
|
198
|
+
q = await session.execute(
|
|
199
|
+
select(Session).where(
|
|
200
|
+
Session.token_hash == token_hash,
|
|
201
|
+
Session.revoked_at.is_(None),
|
|
202
|
+
Session.expires_at > utc_now(),
|
|
203
|
+
)
|
|
204
|
+
)
|
|
205
|
+
|
|
206
|
+
auth_session = q.scalar_one_or_none()
|
|
207
|
+
|
|
208
|
+
if auth_session is None:
|
|
209
|
+
return
|
|
210
|
+
|
|
211
|
+
auth_session.revoked_at = utc_now()
|
|
212
|
+
await session.commit()
|
|
213
|
+
|
|
214
|
+
async def get_current_user(self, token_raw: str) -> User | None:
|
|
215
|
+
token_hash = hash_session_token(token_raw)
|
|
216
|
+
|
|
217
|
+
async with self.session_factory() as session:
|
|
218
|
+
q = await session.execute(
|
|
219
|
+
select(Session).where(
|
|
220
|
+
Session.token_hash == token_hash,
|
|
221
|
+
Session.revoked_at.is_(None),
|
|
222
|
+
Session.expires_at > utc_now(),
|
|
223
|
+
)
|
|
224
|
+
)
|
|
225
|
+
auth_session = q.scalar_one_or_none()
|
|
226
|
+
|
|
227
|
+
if auth_session is None:
|
|
228
|
+
return None
|
|
229
|
+
|
|
230
|
+
q = await session.execute(
|
|
231
|
+
select(User).where(User.id == auth_session.user_id)
|
|
232
|
+
)
|
|
233
|
+
user = q.scalar_one_or_none()
|
|
234
|
+
if user is None:
|
|
235
|
+
return None
|
|
236
|
+
|
|
237
|
+
return user
|
authloom/settings.py
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
from typing import Literal, Self
|
|
2
|
+
|
|
3
|
+
from pydantic import BaseModel, Field, model_validator
|
|
4
|
+
from pydantic_settings import BaseSettings
|
|
5
|
+
from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class AuthLoomCookieSessionConfig(BaseModel):
|
|
9
|
+
cookie_name: str = Field(
|
|
10
|
+
default="authloom.auth",
|
|
11
|
+
description="Name of the auth session cookie",
|
|
12
|
+
min_length=1,
|
|
13
|
+
)
|
|
14
|
+
ttl: int = Field(default=604800, description="TTL in seconds", gt=0)
|
|
15
|
+
http_only: bool = True
|
|
16
|
+
secure: bool = False
|
|
17
|
+
samesite: Literal["lax", "strict", "none"] = "lax"
|
|
18
|
+
domain: str | None = None
|
|
19
|
+
path: str = Field(default="/", min_length=1)
|
|
20
|
+
|
|
21
|
+
@model_validator(mode="after")
|
|
22
|
+
def validate_samesite_secure_options(self) -> Self:
|
|
23
|
+
if self.samesite == "none" and not self.secure:
|
|
24
|
+
raise ValueError("samesite `none` required secure to be `true`")
|
|
25
|
+
|
|
26
|
+
return self
|
|
27
|
+
|
|
28
|
+
@model_validator(mode="after")
|
|
29
|
+
def validate_path(self) -> Self:
|
|
30
|
+
if not self.path.startswith("/"):
|
|
31
|
+
raise ValueError("path value should start with `/`")
|
|
32
|
+
|
|
33
|
+
return self
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
class AuthLoomPasswordConfig(BaseModel):
|
|
37
|
+
min_length: int = Field(default=15)
|
|
38
|
+
max_length: int = Field(default=64)
|
|
39
|
+
|
|
40
|
+
@model_validator(mode="after")
|
|
41
|
+
def validate_lengths(self) -> Self:
|
|
42
|
+
if self.min_length < 15:
|
|
43
|
+
raise ValueError("min_length cannot be less than 15 characters")
|
|
44
|
+
|
|
45
|
+
if self.max_length < 64:
|
|
46
|
+
raise ValueError("max_length cannot be less than 64 characters")
|
|
47
|
+
|
|
48
|
+
if self.max_length > 128:
|
|
49
|
+
raise ValueError("max_length cannot be more than 128 characters")
|
|
50
|
+
|
|
51
|
+
if self.min_length > self.max_length:
|
|
52
|
+
raise ValueError("min_length cannot be greater than max_length")
|
|
53
|
+
|
|
54
|
+
return self
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
class AuthLoomConfig(BaseSettings):
|
|
58
|
+
cookie_session: AuthLoomCookieSessionConfig = Field(
|
|
59
|
+
default_factory=AuthLoomCookieSessionConfig
|
|
60
|
+
)
|
|
61
|
+
session_factory: async_sessionmaker[AsyncSession]
|
|
62
|
+
password_config: AuthLoomPasswordConfig = Field(
|
|
63
|
+
default_factory=AuthLoomPasswordConfig
|
|
64
|
+
)
|
|
@@ -0,0 +1,238 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: authloom
|
|
3
|
+
Version: 0.1.0a1
|
|
4
|
+
Summary: Authentication building blocks for FastAPI applications
|
|
5
|
+
Keywords: fastapi,authentication
|
|
6
|
+
Author: Sreekar Nutulapati
|
|
7
|
+
Author-email: Sreekar Nutulapati <sreekarnv1@gmail.com>
|
|
8
|
+
License-Expression: Apache-2.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Framework :: FastAPI
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Typing :: Typed
|
|
15
|
+
Requires-Dist: argon2-cffi>=25.1.0
|
|
16
|
+
Requires-Dist: cuid2>=2.0.1
|
|
17
|
+
Requires-Dist: email-normalize>=3.1.0
|
|
18
|
+
Requires-Dist: fastapi>=0.140.0
|
|
19
|
+
Requires-Dist: pydantic-settings>=2.14.2
|
|
20
|
+
Requires-Dist: pydantic[email]>=2.13.4
|
|
21
|
+
Requires-Dist: sqlalchemy>=2.0.51
|
|
22
|
+
Requires-Python: >=3.12
|
|
23
|
+
Project-URL: Homepage, https://github.com/sreekarnv/authloom
|
|
24
|
+
Project-URL: Repository, https://github.com/sreekarnv/authloom
|
|
25
|
+
Project-URL: Issues, https://github.com/sreekarnv/authloom/issues
|
|
26
|
+
Project-URL: Changelog, https://github.com/sreekarnv/authloom/blob/main/CHANGELOG.md
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
|
|
29
|
+
# AuthLoom
|
|
30
|
+
|
|
31
|
+
AuthLoom is a Python 3.12 authentication library for FastAPI applications.
|
|
32
|
+
|
|
33
|
+
It currently provides email/password signup and signin, cookie-backed database sessions, required and optional current-user dependencies, Argon2 password hashing, normalized email handling, hashed session tokens, expiry, and signout revocation.
|
|
34
|
+
|
|
35
|
+
AuthLoom is pre-release software. APIs and database integration details may change before the first stable release.
|
|
36
|
+
|
|
37
|
+
## Installation
|
|
38
|
+
|
|
39
|
+
Using `uv`:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
uv add "authloom==0.1.0a1"
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Using `pip`:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
pip install "authloom==0.1.0a1"
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Requirements
|
|
52
|
+
|
|
53
|
+
- Python `>=3.12`
|
|
54
|
+
- FastAPI `>=0.140.0`
|
|
55
|
+
- SQLAlchemy `>=2.0.51` with async sessions
|
|
56
|
+
|
|
57
|
+
## Basic Usage
|
|
58
|
+
|
|
59
|
+
Applications provide the async SQLAlchemy session factory and own database setup.
|
|
60
|
+
|
|
61
|
+
```python
|
|
62
|
+
from typing import Annotated
|
|
63
|
+
|
|
64
|
+
from fastapi import Depends, FastAPI
|
|
65
|
+
from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
|
|
66
|
+
|
|
67
|
+
from authloom import AuthLoom, AuthLoomConfig, create_auth_router
|
|
68
|
+
from authloom.db import User
|
|
69
|
+
|
|
70
|
+
engine = create_async_engine("sqlite+aiosqlite:///./app.db")
|
|
71
|
+
SessionLocal = async_sessionmaker(
|
|
72
|
+
engine,
|
|
73
|
+
class_=AsyncSession,
|
|
74
|
+
expire_on_commit=False,
|
|
75
|
+
)
|
|
76
|
+
|
|
77
|
+
auth = AuthLoom(config=AuthLoomConfig(session_factory=SessionLocal))
|
|
78
|
+
|
|
79
|
+
app = FastAPI()
|
|
80
|
+
app.include_router(create_auth_router(auth))
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
@app.get("/protected")
|
|
84
|
+
async def protected_route(
|
|
85
|
+
user: Annotated[User, Depends(auth.require_current_user)],
|
|
86
|
+
):
|
|
87
|
+
return {"id": user.id, "email": user.email}
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
@app.get("/optional")
|
|
91
|
+
async def optional_route(
|
|
92
|
+
user: Annotated[User | None, Depends(auth.optional_current_user)],
|
|
93
|
+
):
|
|
94
|
+
return {"authenticated": user is not None}
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Routes
|
|
98
|
+
|
|
99
|
+
`create_auth_router(auth)` creates a FastAPI router mounted at `/auth`.
|
|
100
|
+
|
|
101
|
+
| Method | Path | Description |
|
|
102
|
+
| --- | --- | --- |
|
|
103
|
+
| `POST` | `/auth/signup` | Create a user, create a session, and set the session cookie. |
|
|
104
|
+
| `POST` | `/auth/signin` | Verify credentials, create a session, and set the session cookie. |
|
|
105
|
+
| `POST` | `/auth/signout` | Revoke the current session and delete the session cookie when present. |
|
|
106
|
+
| `GET` | `/auth/me` | Return the current authenticated user. |
|
|
107
|
+
|
|
108
|
+
## Configuration
|
|
109
|
+
|
|
110
|
+
The required configuration value is `session_factory`.
|
|
111
|
+
|
|
112
|
+
```python
|
|
113
|
+
from authloom import AuthLoom, AuthLoomConfig
|
|
114
|
+
from authloom.settings import AuthLoomCookieSessionConfig, AuthLoomPasswordConfig
|
|
115
|
+
|
|
116
|
+
auth = AuthLoom(
|
|
117
|
+
config=AuthLoomConfig(
|
|
118
|
+
session_factory=SessionLocal,
|
|
119
|
+
cookie_session=AuthLoomCookieSessionConfig(
|
|
120
|
+
cookie_name="authloom.auth",
|
|
121
|
+
ttl=60 * 60 * 24 * 7,
|
|
122
|
+
http_only=True,
|
|
123
|
+
secure=True,
|
|
124
|
+
samesite="lax",
|
|
125
|
+
path="/",
|
|
126
|
+
),
|
|
127
|
+
password_config=AuthLoomPasswordConfig(
|
|
128
|
+
min_length=15,
|
|
129
|
+
max_length=64,
|
|
130
|
+
),
|
|
131
|
+
)
|
|
132
|
+
)
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Cookie settings:
|
|
136
|
+
|
|
137
|
+
| Option | Default | Notes |
|
|
138
|
+
| --- | --- | --- |
|
|
139
|
+
| `cookie_name` | `"authloom.auth"` | Must not be empty. |
|
|
140
|
+
| `ttl` | `604800` | Lifetime in seconds. Must be greater than zero. |
|
|
141
|
+
| `http_only` | `True` | Prevents browser JavaScript from reading the cookie. |
|
|
142
|
+
| `secure` | `False` | Use `True` in HTTPS production deployments. |
|
|
143
|
+
| `samesite` | `"lax"` | One of `"lax"`, `"strict"`, or `"none"`. `"none"` requires `secure=True`. |
|
|
144
|
+
| `domain` | `None` | Optional cookie domain. |
|
|
145
|
+
| `path` | `"/"` | Must not be empty and must start with `/`. |
|
|
146
|
+
|
|
147
|
+
Password settings:
|
|
148
|
+
|
|
149
|
+
| Option | Default | Validation |
|
|
150
|
+
| --- | --- | --- |
|
|
151
|
+
| `min_length` | `15` | Cannot be less than `15` and cannot exceed `max_length`. |
|
|
152
|
+
| `max_length` | `64` | Cannot be less than `64` or greater than `128`. |
|
|
153
|
+
|
|
154
|
+
Use `secure=True` for HTTPS production deployments.
|
|
155
|
+
|
|
156
|
+
See `docs/configuration.md` for the full configuration reference.
|
|
157
|
+
|
|
158
|
+
## Database And Migrations
|
|
159
|
+
|
|
160
|
+
AuthLoom does not own migrations. Applications own Alembic setup and migration history.
|
|
161
|
+
|
|
162
|
+
Include AuthLoom metadata in the application Alembic configuration when generating migrations:
|
|
163
|
+
|
|
164
|
+
```python
|
|
165
|
+
from authloom.db import metadata as authloom_metadata
|
|
166
|
+
|
|
167
|
+
target_metadata = [authloom_metadata, your_app_metadata]
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
Do not rely on `metadata.create_all()` for production schema management.
|
|
171
|
+
|
|
172
|
+
See `docs/database-and-migrations.md` for more detail.
|
|
173
|
+
|
|
174
|
+
## Security Model
|
|
175
|
+
|
|
176
|
+
AuthLoom currently provides:
|
|
177
|
+
|
|
178
|
+
- Argon2 password hashing.
|
|
179
|
+
- Email normalization before signup and signin.
|
|
180
|
+
- Random session tokens sent to clients only through cookies.
|
|
181
|
+
- SHA-256 hashes of session tokens stored in the database.
|
|
182
|
+
- Session expiry based on the configured cookie/session lifetime.
|
|
183
|
+
- Session revocation during signout.
|
|
184
|
+
- `HttpOnly` cookie support.
|
|
185
|
+
- Generic invalid-credential responses for signin failures.
|
|
186
|
+
|
|
187
|
+
Production deployments should use HTTPS and `secure=True` cookies. AuthLoom does not add a separate CSRF protection system beyond the configured cookie policy.
|
|
188
|
+
|
|
189
|
+
See `docs/security.md` for more detail.
|
|
190
|
+
|
|
191
|
+
## v0.1 Limitations
|
|
192
|
+
|
|
193
|
+
AuthLoom does not currently provide:
|
|
194
|
+
|
|
195
|
+
- Rate limiting or brute-force protection.
|
|
196
|
+
- Email verification.
|
|
197
|
+
- Password reset or password change flows.
|
|
198
|
+
- Multi-factor authentication.
|
|
199
|
+
- OAuth or social login.
|
|
200
|
+
- JWT access or refresh tokens.
|
|
201
|
+
- Roles, permissions, organizations, or multi-tenancy.
|
|
202
|
+
- Session cleanup jobs for expired or revoked sessions.
|
|
203
|
+
- Packaged database migrations or a migration CLI.
|
|
204
|
+
|
|
205
|
+
## Example Application
|
|
206
|
+
|
|
207
|
+
See `examples/credentials_auth_basic/` for a SQLite FastAPI example.
|
|
208
|
+
|
|
209
|
+
## Development
|
|
210
|
+
|
|
211
|
+
Install development and test dependencies:
|
|
212
|
+
|
|
213
|
+
```bash
|
|
214
|
+
uv sync --locked --group dev --group test
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
Run Ruff:
|
|
218
|
+
|
|
219
|
+
```bash
|
|
220
|
+
uv run ruff check .
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
Run tests:
|
|
224
|
+
|
|
225
|
+
```bash
|
|
226
|
+
uv run pytest tests/unit
|
|
227
|
+
uv run pytest tests/integration
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
Build the package:
|
|
231
|
+
|
|
232
|
+
```bash
|
|
233
|
+
uv build
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
## License
|
|
237
|
+
|
|
238
|
+
This project is licensed under the Apache License 2.0. See `LICENSE` for details.
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
authloom/__init__.py,sha256=xTDg11Ac57Uj3KczBbL-v6reEHqGFqjSggWoF3zsgjw,180
|
|
2
|
+
authloom/db/__init__.py,sha256=6qOY1cY9YDbBZLAU_kHkSTGUxGyQt6j5Q6gK1OQ6xFQ,253
|
|
3
|
+
authloom/db/schema.py,sha256=BHiNFuf00wj3LGtMibN-dpNB-1zUgEJx2DcSSIzJumU,1649
|
|
4
|
+
authloom/db/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
5
|
+
authloom/db/utils/time.py,sha256=41YUnTvWmCBgpUn3rRtvGhoy2PnidU_gB528OviD4Lc,877
|
|
6
|
+
authloom/dtos.py,sha256=mJlS_QQUZpqcT74b8AeVw6GBOjpn-sK8naH_FkOmZ6M,1399
|
|
7
|
+
authloom/exceptions.py,sha256=xikHNB6Tu_kjckao9D4ubqNbmMJtCbSta4hLIb1hSyw,507
|
|
8
|
+
authloom/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
9
|
+
authloom/router.py,sha256=goDekdgbp5tQr3sj9UWZp4m2iyq-awUGmIK0ErBRrkk,4418
|
|
10
|
+
authloom/service.py,sha256=SxJH3ka2bXAOaEzINBUDEILKo28wI-3DuWzKNKF9Gg0,7829
|
|
11
|
+
authloom/settings.py,sha256=iOkWCnOWFDCbEFlSLpKXVHz8qYSyiRjo-ZUQS8k28i8,2091
|
|
12
|
+
authloom-0.1.0a1.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
|
|
13
|
+
authloom-0.1.0a1.dist-info/WHEEL,sha256=oy45bIW3ehK02fnLDUKD-FzeaR3VpJxY5Jdblkktnpw,80
|
|
14
|
+
authloom-0.1.0a1.dist-info/METADATA,sha256=1gHnF4yma85VcU_9XJQeztf-nJsTIo1AIpbT02zMdaY,6816
|
|
15
|
+
authloom-0.1.0a1.dist-info/RECORD,,
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|