தரவு மாதிரிகள்¶
இந்த குறிப்பு Canaille பயன்படுத்தும் தரவு மாதிரிகளை விவரிக்கிறது. இது பெரும்பாலும் டெவலப்பர்களுக்கு பயனுள்ளதாக இருக்கும்.
- class canaille.backends.models.BackendModel[source]¶
Bases:
objectபின்தள மாதிரி சுருக்க வகுப்பு.
ஒவ்வொரு மாதிரி மற்றும் ஒவ்வொரு பின்தளத்திற்கும் செயல்படுத்தப்படும் என்று எதிர்பார்க்கப்படும் அனைத்து முறைகள் மற்றும் பண்புக்கூறுகளை இது விவரிக்கிறது.
- class canaille.backends.models.Model[source]¶
Bases:
objectமாதிரி சுருக்க வகுப்பு.
இது ஒவ்வொரு மாடல்களாலும் பகிரப்படும் அனைத்து பொதுவான பண்புகளையும் விவரிக்கிறது.
- id: str | None = None¶
பணி வழங்குநரால் வரையறுக்கப்பட்ட SCIM ஆதாரத்திற்கான தனிப்பட்ட அடையாளங்காட்டி.
Backend.saveமுறை அழைக்கப்படும் வரை அடையாளம்Noneஆக இருக்கும்.ஆதாரத்தின் ஒவ்வொரு பிரதிநிதித்துவமும் காலியாக இல்லாத "அடையாளம்" மதிப்பைக் கொண்டிருக்க வேண்டும். இந்த அடையாளங்காட்டியானது SCIM பணி வழங்குநரின் முழு வளங்களிலும் தனித்துவமாக இருக்க வேண்டும். இது ஒரு நிலையான, மறுஒதுக்கீடு செய்ய முடியாத அடையாளங்காட்டியாக இருக்க வேண்டும், அதே சான்று அடுத்தடுத்த கோரிக்கைகளில் திரும்பும்போது மாறாது. "அடையாளம்" பண்புக்கூறின் மதிப்பு எப்போதும் பணி வழங்குநரால் வழங்கப்படும் மற்றும் கிளையண்டால் குறிப்பிடப்படக்கூடாது. சரம் "bulkId" ஒரு ஒதுக்கப்பட்ட முக்கிய சொல் மற்றும் எந்தவொரு தனிப்பட்ட அடையாளங்காட்டி மதிப்பிலும் பயன்படுத்தப்படக்கூடாது. பண்புக்கூறு பண்புகள் "caseExact" என்பது "உண்மை", "படிக்க மட்டும்" என்பதன் மாறுதல் மற்றும் "எப்போதும்" என்பதன் "திரும்பிய" பண்பு. தனியுரிமை தொடர்பான கூடுதல் பரிசீலனைகளுக்கு பிரிவு 9 ஐப் பார்க்கவும்.
- property identifier¶
மாதிரி நிகழ்வை அடையாளம் காண பயன்படுத்தப்படும் தனித்துவமான மதிப்பை வழங்கவும்.
இந்த மதிப்பு canaille இல் உள்ள முகவரி களில் பயன்படுத்தப்படும், எனவே இது தனிப்பட்டதாகவும் குறுகியதாகவும் இருக்க வேண்டும்.
- class canaille.core.models.Group[source]¶
Bases:
Modelகுழு மாதிரி.
SCIM குரூப் ச்கீமா அடிப்படையில்.
- members: list[~typing.Annotated[~canaille.core.models.User, {'backref': 'groups'}]] = []¶
குழுவின் உறுப்பினர்களின் பட்டியல்.
மதிப்புகள் சேர்க்கப்படலாம் அல்லது அகற்றப்படலாம், உறுப்பினர்களின் துணை பண்புக்கூறுகள் "மாறாதவை". "மதிப்பு" துணை பண்புக்கூறில் SCIM ஆதாரத்தின் "id" பண்புக்கூறு மதிப்பு உள்ளது, மேலும் "$ref" துணை பண்புக்கூறு "பயனர்" அல்லது "குழு" போன்ற SCIM ஆதாரத்தின் யூரி ஆக இருக்க வேண்டும். "குழு" வகையின் நோக்கம், உள்ளமைக்கப்பட்ட குழுக்களை ஆதரிக்க பணி வழங்குநரை அனுமதிப்பதாகும். பணி வழங்குநர்கள் "குழு" ஆதார திட்டத்தில் "உறுப்பினர்கள்" பண்புக்கூறின் துணை பண்புக்கூறின் "தேவையான" பண்புக்கூறுகளை அமைப்பதன் மூலம் வாடிக்கையாளர்களுக்கு காலியாக இல்லாத மதிப்பை வழங்க வேண்டும்.
- class canaille.core.models.User(*args, **kwargs)[source]¶
Bases:
Modelபயனர் மாதிரி.
SCIM பயனர் ச்கீமாவை அடிப்படையாகக் கொண்டு, Entreprise பயனர் Schema Extension <https://datatracker.ietf.org/doc/html/rfc76>Password Management and.IML/rfc76> நீட்டிப்பு வரைவு. பண்புக்கூறு விளக்கம் SCIM ஐ அடிப்படையாகக் கொண்டது மற்றும் செய்தி நோக்கத்திற்காக வைக்கப்பட்டுள்ளது. இந்த விளக்கம் Canaille இல் தற்போது செயல்படுத்தப்படாமல் இருக்கலாம்.
- can(*permissions: Permission) bool[source]¶
<canaille.core.configuration.ACLSettings>`
configuration இன் படி பயனரிடம் :class:`~canaille.core.configuration.Permissionஉள்ளதா இல்லையா.
- display_name: str | None = None¶
பயனரின் பெயர், இறுதிப் பயனர்களுக்குக் காட்ட ஏற்றது.
திரும்பிய ஒவ்வொரு பயனரும் காலியாக இல்லாத டிச்ப்ளே பெயர் மதிப்பை உள்ளடக்கியிருக்கலாம். தெரிந்திருந்தால், விவரித்த பயனரின் முழுப் பெயராக அந்தப் பெயர் இருக்க வேண்டும் (எ.கா., "பாப்ச் சென்சன்" அல்லது "திருமதி. பார்பரா சே சென்சன், III") ஆனால் அது மட்டுமே இருந்தால் (எ.கா., "பிசென்சன்") பயனர்பெயர் அல்லது கைப்பிடியாக இருக்கலாம். வழங்கப்பட்ட மதிப்பு, இறுதிப் பயனர்களுக்கு வழங்கும்போது, சேவை வழங்குநரால் இந்தப் பயனரைக் காண்பிக்கும் முதன்மை உரை லேபிளாக இருக்க வேண்டும்.
- emails: list[str] = []¶
பயனருக்கான மின்னஞ்சல் முகவரிகள்.
மதிப்பு [RFC5321] இன் படி குறிப்பிடப்பட வேண்டும். பணி வழங்குநர்கள் [RFC5321] இன் படி மதிப்பை நியதியாக்க வேண்டும், எ.கா., "bjensen@EXAMPLE.COM" என்பதற்குப் பதிலாக "bjensen@example.com". "காட்சி" துணை பண்புக்கூறு மின்னஞ்சல் மதிப்பின் நியமன பிரதிநிதித்துவத்தை வழங்குவதற்கு பயன்படுத்தப்படலாம். "வகை" துணை பண்புக்கூறு (மனித) பயனருக்கு அர்த்தமுள்ள வகைப்பாட்டை வழங்க பயன்படுகிறது. பயனர் இடைமுகம் "வேலை", "வீடு" மற்றும் "மற்றவை" ஆகியவற்றின் அடிப்படை மதிப்புகளைப் பயன்படுத்துவதை ஊக்குவிக்க வேண்டும் மற்றும் SCIM கிளையண்டுகளின் விருப்பப்படி கூடுதல் வகை மதிப்புகளைப் பயன்படுத்த அனுமதிக்கலாம்.
- employee_number: str | None = None¶
ஒரு சரம் அடையாளங்காட்டி, பொதுவாக எண் அல்லது எண்ணெழுத்து, ஒரு நபருக்கு ஒதுக்கப்படும், பொதுவாக வாடகை வரிசை அல்லது நிறுவனத்துடனான தொடர்பின் அடிப்படையில்.
- family_name: str | None = None¶
பயனரின் குடும்பப் பெயர், அல்லது பெரும்பாலான மேற்கத்திய மொழிகளில் கடைசிப் பெயர் (எ.கா., "சென்சன்" என்பது "திருமதி. பார்பரா சேன் சென்சன், III" என்ற முழுப் பெயராகும்).
- formatted_address: str | None = None¶
முழு அஞ்சல் முகவரி, ஒரு அஞ்சல் லேபிளுடன் காட்சிப்படுத்த அல்லது பயன்படுத்த வடிவமைக்கப்பட்டுள்ளது.
இந்தப் பண்புக்கூறில் புதிய வரிகள் இருக்கலாம்.
- formatted_name: str | None = None¶
அனைத்து நடுப்பெயர்கள், தலைப்புகள் மற்றும் பின்னொட்டுகள் ஆகியவற்றை உள்ளடக்கிய முழுப் பெயர், காட்சிக்காக வடிவமைக்கப்பட்டுள்ளது (எ.கா., "திருமதி. பார்பரா சேன் சென்சன், III").
- given_name: str | None = None¶
பயனரின் கொடுக்கப்பட்ட பெயர், அல்லது பெரும்பாலான மேற்கத்திய மொழிகளில் முதல் பெயர் (எ.கா., "பார்பரா" என்பது "திருமதி. பார்பரா சேன் சென்சன், III" என்ற முழுப் பெயரைக் கொண்டது).
- groups: list[~typing.Annotated[~canaille.core.models.Group, {'backref': 'members'}]] = []¶
நேரடி உறுப்பினர் மூலமாகவோ, உள்ளமைக்கப்பட்ட குழுக்கள் மூலமாகவோ அல்லது மாறும் வகையில் கணக்கிடப்பட்டதாகவோ பயனர் சேர்ந்த குழுக்களின் பட்டியல்.
மதிப்புகள் பொதுவான குழு அடிப்படையிலான அல்லது பங்கு அடிப்படையிலான அணுகல் கட்டுப்பாட்டு மாதிரிகளின் வெளிப்பாட்டை செயல்படுத்துவதாகும், இருப்பினும் வெளிப்படையான அங்கீகார மாதிரி வரையறுக்கப்படவில்லை. குழு உறுப்பினர்களின் சொற்பொருள் மற்றும் உறுப்பினரின் விளைவாக வழங்கப்பட்ட எந்தவொரு நடத்தை அல்லது அங்கீகாரமும் பணி வழங்குநரால் வரையறுக்கப்படுகிறது. "நேரடி" மற்றும் "மறைமுக" என்ற நியமன வகைகள் குழு உறுப்பினர் எவ்வாறு பெறப்பட்டது என்பதை விவரிக்க வரையறுக்கப்படுகிறது. நேரடி குழு உறுப்பினர் என்பது பயனர் குழுவுடன் நேரடியாக தொடர்புடையவர் என்பதைக் குறிக்கிறது மற்றும் வாடிக்கையாளர்கள் "குழு" ஆதாரத்தின் மூலம் உறுப்பினர்களை மாற்றலாம் என்பதைக் குறிக்க வேண்டும். மறைமுக உறுப்பினர் என்பது பயனர் உறுப்பினர் இடைநிலை அல்லது ஆற்றல் மிக்கது என்பதைக் குறிக்கிறது மற்றும் வாடிக்கையாளர்கள் "குழு" ஆதாரத்தின் மூலம் மறைமுக குழு உறுப்பினர்களை மாற்ற முடியாது, ஆனால் "குழு" ஆதாரத்தின் மூலம் நேரடி குழு உறுப்பினர்களை மாற்றலாம், இது மறைமுக உறுப்பினர்களை பாதிக்கலாம். SCIM பணி வழங்குநர் ஒரு "குழு" ஆதாரத்தை வெளிப்படுத்தினால், "மதிப்பு" துணைப் பண்பு "id" ஆக இருக்க வேண்டும், மேலும் "$ref" துணை பண்புக்கூறு பயனரின் தொடர்புடைய "குழு" ஆதாரங்களின் யூரி ஆக இருக்க வேண்டும். இந்தப் பண்புக்கூறு "படிக்க மட்டும்" என்ற மாற்றத்தைக் கொண்டிருப்பதால், குழு உறுப்பினர் மாற்றங்கள் "குழு" சான்று (பிரிவு 4.2) வழியாகப் பயன்படுத்தப்பட வேண்டும். இந்தப் பண்பு "படிக்க மட்டும்" என்ற மாற்றத்தைக் கொண்டுள்ளது.
- has_webauthn_credential() bool[source]¶
பயனருக்காக WebAuthn நற்சான்றிதழ் பதிவு செய்யப்பட்டுள்ளதா என்பதைச் சரிபார்க்கவும்.
- hotp_counter: int | None = None¶
HMAC அடிப்படையிலான ஒரு முறை கடவுச்சொல் கவுண்டர், பல காரணி அங்கீகாரத்திற்காகப் பயன்படுத்தப்படுகிறது.
- last_otp_login: datetime | None = None¶
ஒரு முறை கடவுக்குறியீடு மூலம் பயனர் கடைசியாக எப்போது உள்நுழைந்தார் என்பதைக் குறிக்கும் தேதிநேரம். ஒரு முறை கடவுக்குறியீடு அங்கீகாரத்தை பயனர் செயல்படுத்தியுள்ளாரா இல்லையா என்பதைச் சரிபார்க்க இந்தப் பண்பு தற்போது பயன்படுத்தப்படுகிறது.
- one_time_password: str | None = None¶
ஒரு முறை கடவுச்சொல் மின்னஞ்சல் அல்லது எச்எம்எச் பல காரணி அங்கீகாரத்திற்கு பயன்படுத்தப்படுகிறது.
- one_time_password_emission_date: datetime | None = None¶
பயனர் கடைசியாக மின்னஞ்சல் அல்லது எச்எம்எச் ஒரு முறை கடவுக்குறியீட்டை எப்போது அனுப்பினார் என்பதைக் குறிக்கும் தேதிநேரம்.
- password: str | None = None¶
இந்த பண்புக்கூறு கடவுச்சொல்லை அமைப்பதற்கும், மாற்றுவதற்கும் அல்லது ஒப்பிடுவதற்கும் (அதாவது சமத்துவத்திற்கான வடிகட்டுதல்) வழிமுறையாகப் பயன்படுத்தப்படுகிறது. தெளிவான உரை மதிப்பு அல்லது கடவுச்சொல்லின் ஆச் மதிப்பை பணி வழங்குநரால் திரும்பப் பெற முடியாது. ஒரு பணி வழங்குநர் உள்நாட்டில் மதிப்பை வைத்திருந்தால், மதிப்பு ஆச் செய்யப்பட வேண்டும். கிளையண்டால் கடவுச்சொல் அமைக்கப்படும்போது அல்லது மாற்றப்படும்போது, தெளிவான உரை கடவுச்சொல் பணி வழங்குநரால் பின்வருமாறு செயலாக்கப்பட வேண்டும்:
பன்னாட்டு மொழி ஒப்பீட்டுக்கான தெளிவான உரை மதிப்பைத் தயாரிக்கவும். [RFC7644] இன் பிரிவு 7.8 ஐப் பார்க்கவும்.
சேவையக கடவுச்சொல் கொள்கைக்கு எதிரான மதிப்பைச் சரிபார்க்கவும். குறிப்பு: கடவுச்சொல் கொள்கையின் வரையறை மற்றும் அமலாக்கம் இந்த ஆவணத்தின் எல்லைக்கு அப்பாற்பட்டது.
மதிப்பு குறியாக்கம் செய்யப்பட்டிருப்பதை உறுதிசெய்யவும் (எ.கா. ஆச்). பணிப்பாய்வு காரணங்களுக்காக சேமிக்கும் போது அல்லது தொடரும்போது ஏற்றுக்கொள்ளக்கூடிய ஆசிங் மற்றும் குறியாக்க கையாளுதலுக்கு பிரிவு 9.2 ஐப் பார்க்கவும்.
தெளிவான உரை மதிப்பை உடனடியாக மற்றொரு சிச்டம் அல்லது புரோகிராமிங் இடைமுகத்திற்கு அனுப்பும் ஒரு பணி வழங்குநர், அந்த மதிப்பை ஒரு பாதுகாப்பான இணைப்பில் நேரடியாக அனுப்ப வேண்டும் (எ.கா., போக்குவரத்து அடுக்கு பாதுகாப்பு (TLS)). வழங்குவதற்கு முன், மதிப்பை ஒரு குறிப்பிட்ட காலத்திற்கு (எ.கா., பணிப்பாய்வு காரணமாக) தற்காலிகமாக வைத்திருக்க வேண்டும் என்றால், குறியாக்கம் போன்ற சில முறைகளால் மதிப்பு பாதுகாக்கப்பட வேண்டும்.
ஏற்கனவே சேமிக்கப்பட்ட ஆச் மதிப்பு இருந்தால், சமத்துவப் பொருத்தத்திற்கான சோதனை ஆதரிக்கப்படலாம். சமத்துவத்தை சோதிக்கும் போது, சேவை வழங்குநர்:
பன்னாட்டு மொழி ஒப்பீட்டுக்கான வடிகட்டி மதிப்பைத் தயாரிக்கிறது. [RFC7644] இன் பிரிவு 7.8 ஐப் பார்க்கவும்.
வடிகட்டி மதிப்பின் உப்பு கலந்த ஆசை உருவாக்குகிறது மற்றும் உள்நாட்டில் வைத்திருக்கும் மதிப்புடன் பொருத்தத்தை சோதிக்கிறது.
கடவுச்சொல் பண்புக்கூறின் மாறுபாடு "எழுதுவதற்கு மட்டும்", எந்த வடிவத்திலும் ஒரு பணி வழங்குநரால் மதிப்பைத் திருப்பித் தரக்கூடாது என்பதைக் குறிக்கிறது ("ரிட்டர்ன்ட்" என்ற பண்புக்கூறு "ஒருபோதும் இல்லை").
- password_failure_timestamps: list[datetime] = []¶
இந்த பண்புக்கூறு பயனர் தோல்வியுற்ற அங்கீகாரத்தின் நேரமுத்திரையை சேமிக்கிறது.
இது தற்போது ஊடுருவல் கதவடைப்பு தாமத அமைப்பால் பயன்படுத்தப்படுகிறது.
- password_last_update: datetime | None = None¶
பயனர் கடவுச்சொல் கடைசியாக மாற்றப்பட்டது என்பதைக் குறிப்பிடுகிறது. முன்னிருப்பாக, கடவுச்சொல் உருவாக்கப்பட்ட தேதி தக்கவைக்கப்படுகிறது.
- phone_numbers: list[str] = []¶
பயனருக்கான தொலைபேசி எண்கள்.
[RFC3966] இல் வரையறுக்கப்பட்ட வடிவமைப்பின்படி மதிப்பு குறிப்பிடப்பட வேண்டும், எ.கா., 'டெல்:+1-201-555-0123'. பணி வழங்குநர்கள் பொருத்தமான போது, [RFC3966] வடிவமைப்பின்படி மதிப்பை நியதியாக்க வேண்டும். "டிச்ப்ளே" துணைப் பண்புக்கூறு, ஃபோன் எண் மதிப்பின் நியமனப் பிரதிநிதித்துவத்தை வழங்குவதற்குப் பயன்படுத்தப்படலாம். துணை பண்புக்கூறு "வகை" பெரும்பாலும் "வேலை", "வீடு", "மொபைல்", "தொலைநகல்", "பேசர்" மற்றும் "மற்றவை" ஆகியவற்றின் வழக்கமான மதிப்புகளைக் கொண்டுள்ளது மற்றும் SCIM கிளையன்ட்களால் மேலும் வகைகளை வரையறுக்க அனுமதிக்கலாம்.
- photo: bytes | None = None¶
The binary content of an image representing the user.
SCIM defines this attribute as a URI pointing to the image, but Canaille stores the image content itself.
ஆதாரமானது ஒரு படத்தைக் கொண்ட வலைப்பக்கமாக இல்லாமல் ஒரு கோப்பாக இருக்க வேண்டும் (எ.கா., ஒரு GIF, JPEG அல்லது PNG படக் கோப்பு). பணி வழங்குநர்கள் ஒரே படத்தை வெவ்வேறு அளவுகளில் திருப்பி அனுப்பலாம், இருப்பினும் பல்வேறு அளவுகளில் உள்ள படங்களை விவரிப்பதற்கான தரநிலை தற்போது இல்லை என்பது அங்கீகரிக்கப்பட்டுள்ளது. இந்தப் பயனரால் எடுக்கப்பட்ட தன்னிச்சையான புகைப்படங்களை அனுப்ப இந்தப் பண்புக்கூறு பயன்படுத்தப்படக் கூடாது என்பதை நினைவில் கொள்ளவும்; மாறாக, பயனரை விவரிக்கும் போது காட்சிக்கு ஏற்ற பயனரின் சுயவிவரப் புகைப்படங்கள் அனுப்பப்பட வேண்டும். வகைக்கான நிலையான நியமன மதிப்புகளுக்குப் பதிலாக, இந்தப் பண்பு பிரபலமான புகைப்பட அளவுகளைக் குறிக்க பின்வரும் நியமன மதிப்புகளை வரையறுக்கிறது: "photo" மற்றும் "thumbnail".
- preferred_language: str | None = None¶
பயனரின் விருப்பமான எழுதப்பட்ட அல்லது பேசும் மொழிகளைக் குறிக்கிறது மற்றும் பொதுவாக உள்ளூர்மயமாக்கப்பட்ட பயனர் இடைமுகத்தைத் தேர்ந்தெடுப்பதற்குப் பயன்படுத்தப்படுகிறது.
விருப்பமான இயற்கை மொழிகளின் தொகுப்பை மதிப்பு குறிக்கிறது. மதிப்பின் வடிவம் HTTP ஏற்றுக்கொள்ளும்-மொழி தலைப்புப் புலத்தைப் போலவே உள்ளது ("ஏற்றுக்கொள்ளும்-மொழி:" உட்பட) மற்றும் [RFC7231] இன் பிரிவு 5.3.5 இல் குறிப்பிடப்பட்டுள்ளது. பயனர் முகவரால் (பகிரப்படக்கூடியது) எதைக் குறிப்பிடினாலும், அல்லது ஒரு பயனரை ஈடுபடுத்தாத ஒரு ஊடாடலில் (பொதுவான OAuth 2.0. HTTP Accepter பாணியில் HTTP6749] angTP6749 பாணியில் தொடர்பு கொள்ளாமல், மொழிக் குறிச்சொற்களை [RFC4647] பயனரின் மொழி விருப்பங்களுடன் பொருத்துவதற்கு முகில் பயன்பாடுகளை இயக்குவதே இந்த மதிப்பின் நோக்கமாகும். பேச்சுவார்த்தை நடத்த முடியாது.
- profile_url: str | None = None¶
URI என்பது ஒரு சீரான ஆதார இருப்பிடம் ([RFC3986] இன் பிரிவு 1.1.3 இல் வரையறுக்கப்பட்டுள்ளது) மற்றும் அது பயனரின் நிகழ்நிலை சுயவிவரத்தை (எ.கா., ஒரு வலைப்பக்கம்) குறிக்கும் இடத்தைக் குறிக்கிறது.
[RFC3986] இன் பிரிவு 6.2 இன் படி URIகள் நியமனம் செய்யப்படுகின்றன.
- property readable_fields: set[str]¶
பயனர்
configurationஉள்ளமைவின் படி படிக்கக்கூடிய புலங்கள்.இதில்
writableபுலங்கள் இல்லை.
- secret_token: str | None = None¶
ஒவ்வொரு பயனருக்கும் தனித்த கிள்ளாக்கு உருவாக்கப்படுகிறது, பல காரணி அங்கீகாரத்திற்காகப் பயன்படுத்தப்படுகிறது.
- street: str | None = None¶
முழு தெரு முகவரி கூறு, இதில் வீட்டு எண், தெரு பெயர், பி.ஓ.
பெட்டி, மற்றும் பல வரி நீட்டிக்கப்பட்ட தெரு முகவரி செய்தி. இந்தப் பண்புக்கூறில் புதிய வரிகள் இருக்கலாம்.
- user_name: str¶
பயனருக்கான பணி வழங்குநரின் தனிப்பட்ட அடையாளங்காட்டி, பொதுவாக பணி வழங்குநருக்கு நேரடியாக ஏற்பு வழங்க பயனரால் பயன்படுத்தப்படுகிறது.
பெரும்பாலும் கணினியில் பயனருக்கு அவர்களின் தனிப்பட்ட அடையாளங்காட்டியாகக் காட்டப்படும் ("id" அல்லது "externalId"க்கு மாறாக, அவை பொதுவாக ஒளிபுகா மற்றும் பயனர் நட்பு அடையாளங்காட்டிகள் அல்ல). ஒவ்வொரு பயனரும் காலியாக இல்லாத பயனர்பெயர் மதிப்பைக் கொண்டிருக்க வேண்டும். இந்த அடையாளங்காட்டியானது பணி வழங்குநரின் பயனர்களின் முழுத் தொகுப்பிலும் தனித்துவமாக இருக்க வேண்டும். இந்தப் பண்புக்கூறு அவசியமானது மற்றும் கேச் உணர்வற்றது.
- webauthn_credentials: list[WebAuthnCredential] = []¶
கடவுச்சொல் இல்லாத/MFA அங்கீகாரத்திற்காக பயனர் பதிவு செய்த WebAuthn நற்சான்றிதழ்கள்.
- class canaille.core.models.WebAuthnCredential[source]¶
Bases:
Modelகடவுச்சொல் இல்லாத/MFA அங்கீகாரத்திற்கான WebAuthn நற்சான்றிதழ்.
- aaguid: bytes | None = None¶
அங்கீகரிப்பு மாதிரியை அடையாளம் காணும் அங்கீகரிப்பு சான்றளிப்பு வழிகாட்டி.
- last_used_at: datetime | None = None¶
இந்த நற்சான்றிதழுடன் கடைசியாக வெற்றிகரமான அங்கீகாரத்தின் நேரமுத்திரை.
- transports: str | None = None¶
ஆதரிக்கப்படும் போக்குவரத்துகளின் JSON-குறியீடு செய்யப்பட்ட பட்டியல் (usb, nfc, ble, Internal, hybrid).
- user: User, {'backref': 'webauthn_credentials'}]¶
இந்த நற்சான்றிதழை வைத்திருக்கும் பயனர்.
- canaille.core.models.string_code(code: int, digit: int) str[source]¶
குறியீடு நீளம் வரையறுக்கப்பட்ட நீளத்துடன் பொருந்தவில்லை என்றால் முன்னணி 0 ஐச் சேர்க்கவும்.
எடுத்துக்காட்டாக, அளவுரு
இலக்கம்=6, ஆனால்குறியீடு=123, இந்த முறை000123வழங்கும்:>>> otp.string_code(123) '000123'
- class canaille.oidc.basemodels.AuthorizationCode[source]¶
Bases:
ModelOpenID இணைப்பு தற்காலிக அங்கீகார குறியீடு வரையறை.
- acr: str | None¶
அங்கீகரிப்பு சூழல் வகுப்பு குறிப்பு. அங்கீகரிப்புச் சூழல் வகுப்பு குறிப்பு மதிப்பைக் குறிப்பிடும் சரம், ஏற்பு திருப்திகரமாகச் செயல்படுத்தப்பட்ட அங்கீகாரச் சூழல் வகுப்பை அடையாளப்படுத்துகிறது.
- class canaille.oidc.basemodels.Client[source]¶
Bases:
ModelOpenID இணை கிளையன்ட் வரையறை.
OAuth 2.0 மாறும் கிளையன்ட் பதிவு நெறிமுறைகள் மற்றும் OpenID இணை RP-Initiated Logout விவரக்குறிப்புகள் அடிப்படையில்
- application_type: str = 'web'¶
விண்ணப்ப வகை. இயல்புநிலை, தவிர்க்கப்பட்டால், இணையம். வரையறுக்கப்பட்ட மதிப்புகள் நேட்டிவ் அல்லது வெப். OAuth மறைமுகமான மானிய வகையைப் பயன்படுத்தும் இணைய வாடிக்கையாளர்கள், https திட்டத்தை redirect_uris எனப் பயன்படுத்தி URLகளை மட்டுமே பதிவு செய்ய வேண்டும்; அவர்கள் உள்ளக ஓச்ட்டை ஓச்ட்பெயராகப் பயன்படுத்தக் கூடாது. பூர்வீக வாடிக்கையாளர்கள் தனிப்பயன் யூரி திட்டங்கள் அல்லது http திட்டத்தைப் பயன்படுத்தி லூப்பேக் URLகளைப் பயன்படுத்தி redirect_uris ஐ மட்டுமே பதிவு செய்ய வேண்டும்; loopback URLகள் உள்ளக புரவலன் அல்லது IP loopback எழுத்துகள் 127.0.0.1 அல்லது [::1] ஐ ஓச்ட்பெயராகப் பயன்படுத்துகின்றன. அங்கீகார சேவையகங்கள் பூர்வீக வாடிக்கையாளர்களுக்கு கூடுதல் கட்டுப்பாடுகளை ஏற்படுத்தலாம். நேட்டிவ் கிளையண்டுகளுக்கான லூப்பேக் கேசைத் தவிர, http திட்டத்தைப் பயன்படுத்தி, அங்கீகார சேவையகங்கள் திசைதிருப்பல் URI மதிப்புகளை நிராகரிக்கலாம். பதிவுசெய்யப்பட்ட அனைத்து வழிமாற்று_யூரிகளும் இந்தக் கட்டுப்பாடுகளுக்கு இணங்குகின்றனவா என்பதை அங்கீகார சேவையகம் சரிபார்க்க வேண்டும். இது பல்வேறு வகையான வாடிக்கையாளர்களுக்கு வாங்கி ஐடியைப் பகிர்வதைத் தடுக்கிறது.
- client_id: str | None¶
தேவை.
OAuth 2.0 கிளையன்ட் அடையாளங்காட்டி சரம். பதிவுசெய்யப்பட்ட கிளையண்டிற்கு இது தற்போது செல்லுபடியாகாது, இருப்பினும் அங்கீகார சேவையகம் அதன் விருப்பப்படி பதிவுசெய்யப்பட்ட கிளையண்டின் பல நிகழ்வுகளுக்கு ஒரே கிளையன்ட் அடையாளங்காட்டியை வழங்கலாம்.
- client_id_issued_at: datetime | None = None¶
விருப்பமானது.
வாடிக்கையாளர் அடையாளங்காட்டி வழங்கப்பட்ட நேரம். நேரம் என்பது 1970-01-01T00:00:00Z முதல் UTC இல் அளவிடப்பட்ட தேதி/நேரம் வரையிலான வினாடிகளின் எண்ணிக்கையாகக் குறிப்பிடப்படுகிறது.
- client_name: str | None = None¶
அங்கீகாரத்தின் போது இறுதிப் பயனருக்கு வழங்கப்பட வேண்டிய கிளையண்டின் மனிதனால் படிக்கக்கூடிய சரம் பெயர்.
தவிர்க்கப்பட்டால், அங்கீகார சேவையகம் அதற்குப் பதிலாக இறுதிப் பயனருக்கு மூல "client_id" மதிப்பைக் காண்பிக்கும். வாடிக்கையாளர்கள் எப்போதும் இந்தப் புலத்தை அனுப்புவது பரிந்துரைக்கப்படுகிறது. பிரிவு 2.2 இல் விவரிக்கப்பட்டுள்ளபடி, இந்தப் புலத்தின் மதிப்பு சர்வதேசமயமாக்கப்படலாம்.
- client_secret: str | None = None¶
விருப்பமானது.
OAuth 2.0 வாங்கி ரகசிய சரம். வழங்கப்பட்டால், இது ஒவ்வொரு "client_id" க்கும் தனிப்பட்டதாக இருக்க வேண்டும் மற்றும் ஒரே "client_id" ஐப் பயன்படுத்தும் கிளையண்டின் பல நிகழ்வுகளுக்குத் தனித்துவமாக இருக்க வேண்டும். OAuth 2.0 [RFC6749], பிரிவு 2.3.1 இல் விவரிக்கப்பட்டுள்ளபடி, கிள்ளாக்கு முடிவுப் புள்ளியை அங்கீகரிக்க ரகசிய வாடிக்கையாளர்களால் இந்த மதிப்பு பயன்படுத்தப்படுகிறது.
- client_secret_expires_at: datetime | None = None¶
"client_secret" வழங்கப்பட்டால் தேவை.
கிளையன்ட் மறைபொருள் காலாவதியாகும் நேரம் அல்லது அது காலாவதியாகவில்லை என்றால் 0. 1970-01-01T00:00:00Z முதல் காலாவதியாகும் தேதி/நேரம் வரை UTC இல் அளவிடப்படும் வினாடிகளின் எண்ணிக்கையாக நேரம் குறிப்பிடப்படுகிறது.
- client_uri: str | None = None¶
கிளையன்ட் பற்றிய தகவலை வழங்கும் வலைப்பக்கத்தின் முகவரி சரம்.
இருந்தால், சர்வர் இந்த URLஐ இறுதிப் பயனருக்கு சொடுக்கு செய்யக்கூடிய முறையில் காண்பிக்க வேண்டும். வாடிக்கையாளர்கள் எப்போதும் இந்தப் புலத்தை அனுப்புவது பரிந்துரைக்கப்படுகிறது. இந்தப் புலத்தின் மதிப்பு சரியான இணையப் பக்கத்தைக் குறிக்க வேண்டும். பிரிவு 2.2 இல் விவரிக்கப்பட்டுள்ளபடி, இந்தப் புலத்தின் மதிப்பு சர்வதேசமயமாக்கப்படலாம்.
- contacts: list[str] = []¶
இந்த கிளையண்டிற்குப் பொறுப்பானவர்களைத் தொடர்புகொள்வதற்கான வழிகளைக் குறிக்கும் சரங்களின் வரிசை, பொதுவாக மின்னஞ்சல் முகவரிகள்.
கிளையண்டிற்கான உதவி கோரிக்கைகளுக்காக, இந்த தொடர்பு முகவரிகளை இறுதிப் பயனர்களுக்கு அங்கீகார சேவையகம் கிடைக்கச் செய்யலாம். தனியுரிமை பரிசீலனைகள் பற்றிய தகவலுக்கு பிரிவு 6 ஐப் பார்க்கவும்.
- default_acr_values: list[str] = []¶
இயல்புநிலை கோரப்பட்ட அங்கீகார சூழல் வகுப்பு குறிப்பு மதிப்புகள். இந்த கிளையண்டின் கோரிக்கைகளைச் செயலாக்குவதற்கு OP கோரப்படும் இயல்புநிலை acr மதிப்புகளைக் குறிப்பிடும் சரங்களின் வரிசை, மதிப்புகள் முன்னுரிமை வரிசையில் தோன்றும். நிகழ்த்தப்பட்ட அங்கீகாரத்தால் திருப்தியடைந்த அங்கீகரிப்பு சூழல் வகுப்பு, வழங்கப்பட்ட அடையாளம் டோக்கனில் உள்ள acr உரிமைகோரல் மதிப்பாக வழங்கப்படும். இந்த அளவுருவின் மூலம் acr உரிமைகோரல் ஒரு தன்னார்வ உரிமைகோரலாக கோரப்படுகிறது. acr_values_supported கண்டுபிடிப்பு உறுப்பு OP ஆல் ஆதரிக்கப்படும் ஆதரிக்கப்படும் acr மதிப்புகளின் பட்டியலைக் கொண்டுள்ளது. acr_values கோரிக்கை அளவுருவில் குறிப்பிடப்பட்டுள்ள மதிப்புகள் அல்லது தனிப்பட்ட acr உரிமைகோரல் கோரிக்கை இந்த இயல்புநிலை மதிப்புகளை மீறும்.
- default_max_age: int | None = None¶
இயல்புநிலை அதிகபட்ச அங்கீகார அகவை. இறுதி-பயனர் குறிப்பிட்ட வினாடிகளை விட நீண்ட காலத்திற்கு முன்பே அங்கீகரிக்கப்பட்டிருந்தால், இறுதிப் பயனர் செயலில் அங்கீகரிக்கப்பட வேண்டும் என்பதைக் குறிப்பிடுகிறது. max_age கோரிக்கை அளவுரு இந்த இயல்புநிலை மதிப்பை மீறுகிறது. தவிர்க்கப்பட்டால், இயல்புநிலை அதிகபட்ச அங்கீகார அகவை குறிப்பிடப்படவில்லை.
- grant_types: list[str] = ['authorization_code', 'refresh_token']¶
OAuth 2.0 கிராண்ட் வகை சரங்களின் வரிசை, கிள்ளாக்கு இறுதிப் புள்ளியில் கிளையன்ட் பயன்படுத்த முடியும். இந்த மானிய வகைகள் பின்வருமாறு வரையறுக்கப்பட்டுள்ளன:
"authorization_code": OAuth 2.0, பிரிவு 4.1 இல் வரையறுக்கப்பட்ட அங்கீகாரக் குறியீடு மானிய வகை.
"inmplicit": OAuth 2.0, பிரிவு 4.2 இல் வரையறுக்கப்பட்ட மறைமுகமான மானிய வகை.
"password": OAuth 2.0, பிரிவு 4.3 இல் வரையறுக்கப்பட்ட ஆதார உரிமையாளர் கடவுச்சொல் நற்சான்றிதழ்கள் மானிய வகை.
"client_credentials": OAuth 2.0, பிரிவு 4.4 இல் வரையறுக்கப்பட்ட கிளையன்ட் நற்சான்றிதழ்கள் மானிய வகை.
"refresh_token": OAuth 2.0, பிரிவு 6 இல் வரையறுக்கப்பட்ட புதுப்பிப்பு கிள்ளாக்கு மானிய வகை.
"urn:ietf:params:oauth:grant-type:jwt-bearer": JWT தாங்குபவர் கிள்ளாக்கு கிராண்ட் வகை OAuth JWT தாங்குபவர் கிள்ளாக்கு சுயவிவரங்களில் [RFC7523] வரையறுக்கப்பட்டுள்ளது.
"urn:ietf:params:oauth:grant-type:saml2-bearer": OAuth SAML 2 தாங்கி கிள்ளாக்கு சுயவிவரங்களில் [RFC7522] வரையறுக்கப்பட்ட SAML 2.0 தாங்கி வலியுறுத்தல் கிராண்ட்.
கிள்ளாக்கு எண்ட்பாயிண்ட் மானிய வகையில் பயன்படுத்தப்பட்டால், இந்த அளவுருவின் மதிப்பு மானிய வகை வரையறையில் வரையறுக்கப்பட்ட கிள்ளாக்கு எண்ட்பாயிண்டிற்கு அனுப்பப்பட்ட "grant_type" அளவுருவின் மதிப்பைப் போலவே இருக்க வேண்டும். OAuth 2.0, பிரிவு 4.5 இல் விவரிக்கப்பட்டுள்ள மானிய வகை நீட்டிப்பு செயல்பாட்டில் வரையறுக்கப்பட்டுள்ள மற்ற மதிப்புகளுக்கு அங்கீகார சேவையகங்கள் அனுமதிக்கலாம். தவிர்க்கப்பட்டால், கிளையன்ட் "authorization_code" கிராண்ட் வகையை மட்டுமே பயன்படுத்துவார் என்பது இயல்புநிலை நடத்தை.
- id_token_encrypted_response_alg: str | None = None¶
இந்த வாடிக்கையாளருக்கு வழங்கப்பட்ட அடையாளம் கிள்ளாக்கை என்க்ரிப்ட் செய்ய JWE alg அல்காரிதம் [JWA] தேவை. இது கோரப்பட்டால், பதில் கையொப்பமிடப்பட்டு பின்னர் குறியாக்கம் செய்யப்படும், இதன் விளைவாக [JWT] இல் வரையறுக்கப்பட்டுள்ளபடி Nested JWT ஆக இருக்கும். இயல்புநிலை, தவிர்க்கப்பட்டால், எந்த குறியாக்கமும் செய்யப்படவில்லை.
- id_token_encrypted_response_enc: str | None = None¶
இந்த வாடிக்கையாளருக்கு வழங்கப்பட்ட அடையாளம் கிள்ளாக்கை என்க்ரிப்ட் செய்ய JWE enc அல்காரிதம் [JWA] தேவை. id_token_encrypted_response_alg குறிப்பிடப்பட்டிருந்தால், இயல்புநிலை id_token_encrypted_response_enc மதிப்பு A128CBC-HS256 ஆகும். id_token_encrypted_response_enc சேர்க்கப்படும் போது, id_token_encrypted_response_alg ஐயும் வழங்க வேண்டும்.
- id_token_signed_response_alg: str = 'RS256'¶
இந்த வாடிக்கையாளருக்கு வழங்கப்பட்ட அடையாளம் டோக்கனில் கையொப்பமிட JWS alg அல்காரிதம் [JWA] தேவை. அங்கீகரிக்கப்பட்ட எண்ட்பாயிண்ட் (அங்கீகாரக் குறியீடு ஃப்ளோவைப் பயன்படுத்தும் போது மட்டும்) எந்த அடையாளம் டோக்கனையும் வழங்காத மறுமொழி வகைகளை மட்டுமே கிளையன்ட் பயன்படுத்தினால் தவிர, எந்த மதிப்பையும் அடையாளம் கிள்ளாக்கு அல்சி மதிப்பாகப் பயன்படுத்தக்கூடாது. இயல்புநிலை, தவிர்க்கப்பட்டால், RS256 ஆகும். கையொப்பத்தைச் சரிபார்ப்பதற்கான பொது விசையானது, OpenID இணை Discovery 1.0 [OpenID.Discovery] இலிருந்து jwks_uri உறுப்பு மூலம் குறிப்பிடப்பட்ட JWK தொகுப்பை மீட்டெடுப்பதன் மூலம் வழங்கப்படுகிறது.
- initiate_login_uri: str | None = None¶
OpenID இணை வயிரம் 1.0 [OpenID.Core] இன் பிரிவு 4 இல் குறிப்பிடப்பட்டுள்ளபடி, RP மூலம் உள்நுழைவைத் தொடங்க மூன்றாம் தரப்பினர் பயன்படுத்தக்கூடிய https திட்டத்தைப் பயன்படுத்தும் URI. யூரி ஆனது GET மற்றும் POST ஆகிய இரண்டிலும் கோரிக்கைகளை ஏற்க வேண்டும். வாடிக்கையாளர் login_hint மற்றும் iss அளவுருக்களை புரிந்து கொள்ள வேண்டும் மற்றும் target_link_uri அளவுருவை ஆதரிக்க வேண்டும்.
- jwks: str | None = None¶
கிளையண்டின் சாதொபொகு வெப் கீ செட் [RFC7517] ஆவண மதிப்பு, இதில் கிளையண்டின் பொது விசைகள் உள்ளன.
இந்தப் புலத்தின் மதிப்பு சரியான JWK தொகுப்பைக் கொண்ட சாதொபொகு பொருளாக இருக்க வேண்டும். கையொப்பமிடுதல் அல்லது குறியாக்கத்தைப் பயன்படுத்தும் உயர்-நிலை நெறிமுறைகளால் இந்த விசைகள் பயன்படுத்தப்படலாம். இந்த அளவுருவானது "jwks_uri" அளவுருவைப் பயன்படுத்த முடியாத கிளையன்ட்களால் பயன்படுத்தப்பட வேண்டும், அதாவது பொது URLகளை புரவலன் செய்ய முடியாத நேட்டிவ் கிளையன்ட்கள். "jwks_uri" மற்றும் "jwks" அளவுருக்கள் இரண்டும் ஒரே கோரிக்கை அல்லது பதிலில் இருக்கக்கூடாது.
- jwks_uri: str | None = None¶
கிளையண்டின் சாதொபொகு வெப் கீ (JWK) செட் [RFC7517] ஆவணத்தைக் குறிப்பிடும் URL சரம், இதில் கிளையண்டின் பொது விசைகள் உள்ளன.
இந்த புலத்தின் மதிப்பு சரியான JWK செட் ஆவணத்தை சுட்டிக்காட்ட வேண்டும். கையொப்பமிடுதல் அல்லது குறியாக்கத்தைப் பயன்படுத்தும் உயர்-நிலை நெறிமுறைகளால் இந்த விசைகள் பயன்படுத்தப்படலாம். எடுத்துக்காட்டாக, கிளையன்ட் அங்கீகாரத்திற்காக JWTகளைப் பயன்படுத்தும் போது கிள்ளாக்கு எண்ட் பாயிண்டிற்கு செய்யப்பட்ட கையொப்பமிடப்பட்ட கோரிக்கைகளை சரிபார்க்க சில பயன்பாடுகளால் இந்த விசைகள் பயன்படுத்தப்படலாம் [RFC7523]. இந்த அளவுருவின் பயன்பாடு "jwks" அளவுருவை விட விரும்பப்படுகிறது, ஏனெனில் இது எளிதாக விசை சுழற்சியை அனுமதிக்கிறது. "jwks_uri" மற்றும் "jwks" அளவுருக்கள் இரண்டும் ஒரே கோரிக்கை அல்லது பதிலில் இருக்கக்கூடாது.
- logo_uri: str | None = None¶
கிளையண்டிற்கான லோகோவைக் குறிப்பிடும் முகவரி சரம்.
இருந்தால், ஒப்புதலின் போது சர்வர் இந்தப் படத்தை இறுதிப் பயனருக்குக் காண்பிக்க வேண்டும். இந்தப் புலத்தின் மதிப்பு சரியான படக் கோப்பைக் குறிக்க வேண்டும். பிரிவு 2.2 இல் விவரிக்கப்பட்டுள்ளபடி, இந்தப் புலத்தின் மதிப்பு சர்வதேசமயமாக்கப்படலாம்.
- policy_uri: str | None = None¶
URL சரம், மனிதர்கள் படிக்கக்கூடிய தனியுரிமைக் கொள்கை ஆவணத்தைச் சுட்டிக்காட்டுகிறது, இது வரிசைப்படுத்தல் நிறுவனம் தனிப்பட்ட தரவை எவ்வாறு சேகரிக்கிறது, பயன்படுத்துகிறது, தக்கவைக்கிறது மற்றும் வெளிப்படுத்துகிறது என்பதை விவரிக்கிறது.
அங்கீகார சேவையகம் இந்த URL வழங்கப்பட்டிருந்தால் இறுதிப் பயனருக்குக் காண்பிக்க வேண்டும். இந்தப் புலத்தின் மதிப்பு சரியான இணையப் பக்கத்தைக் குறிக்க வேண்டும். பிரிவு 2.2 இல் விவரிக்கப்பட்டுள்ளபடி, இந்தப் புலத்தின் மதிப்பு சர்வதேசமயமாக்கப்படலாம்.
- post_logout_redirect_uris: list[str] = []¶
RP ஆல் வழங்கப்பட்ட முகவரி களின் வரிசையானது, ஒரு வெளியேறிய பின், post_logout_redirect_uri அளவுருவைப் பயன்படுத்தி இறுதிப் பயனரின் பயனர் முகவரைத் திருப்பிவிடுமாறு கோரலாம். இந்த URLகள் https திட்டத்தைப் பயன்படுத்த வேண்டும் மற்றும் துறைமுகம், பாதை மற்றும் வினவல் அளவுரு கூறுகளைக் கொண்டிருக்கலாம்; இருப்பினும், OAuth 2.0 [RFC6749] இன் பிரிவு 2.1 இல் வரையறுக்கப்பட்டுள்ளபடி வாங்கி வகை ரகசியமானது, மேலும் OP ஆனது http RP URIகளைப் பயன்படுத்த அனுமதித்தால் http திட்டத்தைப் பயன்படுத்தலாம்.
- redirect_uris: list[str] = []¶
அங்கீகாரக் குறியீடு மற்றும் மறைமுகமான ஓட்டங்கள் போன்ற வழிமாற்று-அடிப்படையிலான ஓட்டங்களில் பயன்படுத்துவதற்கான திசைமாற்ற URI சரங்களின் வரிசை.
OAuth 2.0 [RFC6749] இன் 2வது பிரிவின்படி, திசைதிருப்பலுடன் கூடிய ஃப்ளோகளைப் பயன்படுத்தும் கிளையன்ட்கள் தங்கள் திசைதிருப்பல் யூரி மதிப்புகளைப் பதிவு செய்ய வேண்டும். வழிமாற்று-அடிப்படையிலான ஓட்டங்களுக்கான மாறும் பதிவை ஆதரிக்கும் அங்கீகார சேவையகங்கள் இந்த மேனிலை தரவு மதிப்பிற்கான ஆதரவை செயல்படுத்த வேண்டும்.
- request_object_encryption_alg: str | None = None¶
JWE [JWE] alg படிமுறை [JWA] RP OP க்கு அனுப்பப்படும் கோரிக்கைப் பொருட்களை குறியாக்கப் பயன்படுத்தலாம் என்று அறிவிக்கிறது. சமச்சீர் குறியாக்கம் பயன்படுத்தப்படும் போது இந்த அளவுரு சேர்க்கப்பட வேண்டும், ஏனெனில் இது OP க்கு ஒரு க்ளையன்ட்_சீக்ரெட் மதிப்பை வழங்க வேண்டும், அதில் இருந்து சமச்சீர் விசை பெறப்படும், இல்லையெனில் அது திரும்பப் பெறப்படாது. இந்த அளவுரு இருக்கும் போதும், RP ஆதரிக்கப்படும் மற்ற என்க்ரிப்சன் அல்காரிதம்களைப் பயன்படுத்தலாம் அல்லது என்க்ரிப்ட் செய்யப்படாத கோரிக்கைப் பொருட்களை அனுப்பலாம். கையொப்பமிடுதல் மற்றும் குறியாக்கம் இரண்டும் கோரப்பட்டால், கோரிக்கைப் பொருள் கையொப்பமிடப்பட்டு பின்னர் குறியாக்கம் செய்யப்படும், இதன் விளைவாக [JWT] இல் வரையறுக்கப்பட்டுள்ளபடி Nested JWT ஆக இருக்கும். இயல்புநிலை, தவிர்க்கப்பட்டால், எந்த கோரிக்கைப் பொருட்களையும் குறியாக்கம் செய்யலாமா என்பதை RP அறிவிக்கவில்லை.
- request_object_encryption_enc: str | None = None¶
JWE enc அல்காரிதம் [JWA] RP OP க்கு அனுப்பப்படும் கோரிக்கை பொருள்களை குறியாக்கம் செய்ய பயன்படுத்தலாம் என்று அறிவிக்கிறது. request_object_encryption_alg குறிப்பிடப்பட்டிருந்தால், இயல்புநிலை request_object_encryption_enc மதிப்பு A128CBC-HS256 ஆகும். request_object_encryption_enc சேர்க்கப்படும் போது, request_object_encryption_alg ஐயும் வழங்க வேண்டும்.
- request_object_signing_alg: str | None = None¶
JWS [JWS] alg algorithm [JWA] OP க்கு அனுப்பப்படும் கோரிக்கைப் பொருட்களில் கையொப்பமிடுவதற்குப் பயன்படுத்தப்பட வேண்டும். இந்த அல்காரிதம் மூலம் கையொப்பமிடவில்லை என்றால், இந்த கிளையண்டின் அனைத்து கோரிக்கைப் பொருட்களும் நிராகரிக்கப்பட வேண்டும். கோரிக்கைப் பொருள்கள் OpenID இணை வயிரம் 1.0 [OpenID.Core] பிரிவு 6.1 இல் விவரிக்கப்பட்டுள்ளன. இந்த அல்காரிதம், கோரிக்கைப் பொருளை மதிப்பின் மூலம் அனுப்பும் போது (கோரிக்கை அளவுருவைப் பயன்படுத்தி) மற்றும் குறிப்பு மூலம் அனுப்பப்படும் போது (request_uri அளவுருவைப் பயன்படுத்தி) பயன்படுத்த வேண்டும். சேவையகங்கள் RS256 ஐ ஆதரிக்க வேண்டும். மதிப்பு எதுவும் பயன்படுத்தப்படக்கூடாது. இயல்புநிலை, தவிர்க்கப்பட்டால், OP மற்றும் RP ஆல் ஆதரிக்கப்படும் எந்த அல்காரிதமும் பயன்படுத்தப்படும்.
- request_uris: list[str] = []¶
OP இல் பயன்படுத்த RP ஆல் முன் பதிவு செய்யப்பட்ட கோரிக்கை_uri மதிப்புகளின் வரிசை. OP ஆல் சரிபார்க்கக்கூடிய வகையில் இலக்கு கோரிக்கைப் பொருள் கையொப்பமிடப்படாவிட்டால், இந்த URLகள் https திட்டத்தைப் பயன்படுத்த வேண்டும். சேவையகங்கள் இந்த URIகளால் குறிப்பிடப்பட்ட கோப்புகளின் உள்ளடக்கங்களை தேக்ககப்படுத்தலாம் மற்றும் கோரிக்கையில் பயன்படுத்தப்படும் நேரத்தில் அவற்றை மீட்டெடுக்காது. OP களுக்கு, request_uri மதிப்புகள் தேவை_request_uri_registration கண்டுபிடிப்பு அளவுருவுடன் முன் பதிவு செய்யப்பட வேண்டும். கோரிக்கை கோப்பின் உள்ளடக்கங்கள் எப்போதாவது மாறினால், இந்த URI மதிப்புகள் URI துண்டின் மதிப்பாக யூரி ஆல் குறிப்பிடப்பட்ட கோப்பு உள்ளடக்கங்களின் அடிப்படை64url-குறியீடு செய்யப்பட்ட SHA-256 ஆச் மதிப்பை உள்ளடக்கியிருக்க வேண்டும். யூரி க்கு பயன்படுத்தப்படும் துண்டு மதிப்பு மாறினால், பழைய துண்டு மதிப்புடன் அந்த URIக்கான தற்காலிகச் சேமிப்பு மதிப்பு இனி செல்லுபடியாகாது என்று சர்வருக்கு சமிக்ஞை செய்கிறது.
- require_auth_time: bool = False¶
அடையாளம் டோக்கனில் உள்ள auth_time உரிமைகோரல் தேவையா என்பதைக் குறிப்பிடும் பூலியன் மதிப்பு. மதிப்பு உண்மையாக இருக்கும் போது இது தேவைப்படுகிறது. (இது தவறானது எனில், OpenID இணை வயிரம் 1.0 [OpenID.Core] இன் பிரிவு 5.5.1 இல் விவரிக்கப்பட்டுள்ள உரிமைகோரல் கோரிக்கை அளவுருவைப் பயன்படுத்தி அடையாளம் டோக்கனுக்கான தனிப்பட்ட உரிமைகோரலாக auth_time உரிமைகோரலைக் கோரலாம்.) தவிர்க்கப்பட்டால், இயல்புநிலை மதிப்பு தவறானது.
- require_signed_request_object: bool = False¶
அங்கீகாரக் கோரிக்கையானது கோரிக்கைப் பொருளாகப் பாதுகாக்கப்பட வேண்டும் மற்றும் கோரிக்கை அல்லது request_uri அளவுரு மூலம் வழங்கப்பட வேண்டும் என்பதைக் குறிக்கிறது.
- response_types: list[str] = []¶
OAuth 2.0 பதிலளிப்பு வகை சரங்களின் வரிசை, கிளையன்ட் அங்கீகார முடிவுப் புள்ளியில் பயன்படுத்த முடியும். இந்த பதில் வகைகள் பின்வருமாறு வரையறுக்கப்படுகின்றன:
"code": OAuth 2.0, பிரிவு 4.1 இல் வரையறுக்கப்பட்ட அங்கீகாரக் குறியீடு பதில் வகை.
"டோக்கன்": OAuth 2.0, பிரிவு 4.2 இல் வரையறுக்கப்பட்ட மறைமுகமான பதில் வகை.
அங்கீகார முடிவுப்புள்ளியானது மானிய வகையால் பயன்படுத்தப்பட்டால், இந்த அளவுருவின் மதிப்பு, மானிய வகை வரையறையில் வரையறுக்கப்பட்ட அங்கீகார முடிவுப்புள்ளிக்கு அனுப்பப்பட்ட "response_type" அளவுருவின் மதிப்பைப் போலவே இருக்க வேண்டும். OAuth 2.0, பிரிவு 4.5 இல் விவரிக்கப்பட்டுள்ள மானிய வகை நீட்டிப்பு செயல்பாட்டில் வரையறுக்கப்பட்டுள்ளபடி அங்கீகார சேவையகங்கள் பிற மதிப்புகளை அனுமதிக்கலாம். தவிர்க்கப்பட்டால், கிளையன்ட் "குறியீடு" மறுமொழி வகையை மட்டுமே பயன்படுத்துவார் என்பது இயல்பு.
- scope: list[str] = []¶
அணுகல் டோக்கன்களைக் கோரும்போது கிளையன்ட் பயன்படுத்தக்கூடிய ச்கோப் மதிப்புகளின் (OAuth 2.0 [RFC6749] பிரிவு 3.3 இல் விவரிக்கப்பட்டுள்ளபடி) இடம் பிரிக்கப்பட்ட பட்டியலைக் கொண்ட சரம்.
இந்த பட்டியலில் உள்ள மதிப்புகளின் சொற்பொருள் பணி சார்ந்தது. தவிர்க்கப்பட்டால், அங்கீகார சேவையகம் ஒரு கிளையண்டை இயல்புநிலை ச்கோப்களுடன் பதிவு செய்யலாம்.
- sector_identifier_uri: str | None = None¶
OP மூலம் புனைப்பெயர் அடையாளங்காட்டிகளைக் கணக்கிடுவதற்கு https திட்டத்தைப் பயன்படுத்தும் URL. redirect_uri மதிப்புகளின் ஒற்றை JSON வரிசையைக் கொண்ட கோப்பை முகவரி குறிப்பிடுகிறது. தயவு செய்து பிரிவு 5 ஐப் பார்க்கவும். சோடிவரிசை துணை (பொருள்) மதிப்புகளைப் பயன்படுத்தும் வழங்குநர்கள், சோடிவரிசை அடையாளங்காட்டிகளுக்கான பொருள் அடையாளக் கணக்கீட்டில் வழங்கப்பட்டுள்ள Sector_identifier_uri மதிப்பைப் பயன்படுத்த வேண்டும்.
- software_id: str | None = None¶
கிளையன்ட் உருவாக்குபவர் அல்லது மென்பொருள் வெளியீட்டாளரால் ஒதுக்கப்படும் தனித்துவமான அடையாளங்காட்டி சரம் (எ.கா., உலகளாவிய தனித்துவ அடையாளங்காட்டி (UUID)) மாறும் வகையில் பதிவு செய்யப்பட வேண்டிய கிளையன்ட் மென்பொருளை அடையாளம் காண பதிவு எண்ட் பாயிண்ட்ச் மூலம் பயன்படுத்தப்படுகிறது.
"client_id" போலல்லாமல், இது அங்கீகார சேவையகத்தால் வழங்கப்படுகிறது மற்றும் நிகழ்வுகளுக்கு இடையில் மாறுபட வேண்டும், கிளையன்ட் மென்பொருளின் அனைத்து நிகழ்வுகளுக்கும் "software_id" ஒரே மாதிரியாக இருக்க வேண்டும். ஒரே மென்பொருளின் பல புதுப்பிப்புகள் அல்லது பதிப்புகளில் "software_id" ஒரே மாதிரியாக இருக்க வேண்டும். இந்த புலத்தின் மதிப்பு மனிதர்கள் படிக்கக்கூடியதாக இல்லை மற்றும் பொதுவாக கிளையன்ட் மற்றும் அங்கீகார சேவையகத்திற்கு ஒளிபுகாதாக இருக்கும்.
- software_version: str | None = None¶
"software_id" மூலம் அடையாளம் காணப்பட்ட கிளையன்ட் மென்பொருளுக்கான பதிப்பு அடையாளங்காட்டி சரம்.
அதே "software_id" மூலம் அடையாளம் காணப்பட்ட கிளையன்ட் மென்பொருளுக்கான எந்தப் புதுப்பித்தலும் "software_version" இன் மதிப்பு மாற வேண்டும். இந்தப் புலத்தின் மதிப்பானது சரம் சமத்துவப் பொருத்தத்தைப் பயன்படுத்தி ஒப்பிடப்பட வேண்டும், மேலும் இந்த விவரக்குறிப்பால் வேறு எந்த ஒப்பீட்டு சொற்பொருள்களும் வரையறுக்கப்படவில்லை. இந்த புலத்தின் மதிப்பு இந்த விவரக்குறிப்பின் எல்லைக்கு அப்பாற்பட்டது, ஆனால் இது மனிதர்களால் படிக்கக்கூடியதாக இல்லை மற்றும் பொதுவாக கிளையன்ட் மற்றும் அங்கீகார சேவையகத்திற்கு ஒளிபுகாவாக இருக்கும். கிளையன்ட் மென்பொருளுக்கான புதுப்பிப்பு என்ன என்பதன் வரையறை, இந்த மதிப்பில் மாற்றத்தைத் தூண்டும் என்பது மென்பொருளுக்குக் குறிப்பிட்டது மற்றும் இந்த விவரக்குறிப்பின் எல்லைக்கு வெளியே உள்ளது.
- subject_type: str | None = None¶
இந்த கிளையண்டிற்கான பதில்களுக்கு subject_type கோரப்பட்டது. subject_types_supported டிச்கவரி அளவுருவானது OP க்காக ஆதரிக்கப்படும் subject_type மதிப்புகளின் பட்டியலைக் கொண்டுள்ளது. சரியான வகைகளில் சோடிவரிசை மற்றும் பொது ஆகியவை அடங்கும்.
- token_endpoint_auth_method: str | None = None¶
கிள்ளாக்கு எண்ட்பாயிண்டிற்கான கோரப்பட்ட அங்கீகார முறையின் சரம் காட்டி. இந்த விவரக்குறிப்பால் வரையறுக்கப்பட்ட மதிப்புகள்:
"none": OAuth 2.0, பிரிவு 2.1 இல் வரையறுக்கப்பட்டுள்ளபடி கிளையன்ட் ஒரு பொது கிளையன்ட் மற்றும் வாங்கி மறைபொருள் இல்லை.
"client_secret_post": OAuth 2.0, பிரிவு 2.3.1 இல் வரையறுக்கப்பட்டுள்ளபடி கிளையன்ட் HTTP POST அளவுருக்களைப் பயன்படுத்துகிறது.
"client_secret_basic": The client uses HTTP அடிப்படை அச் defined in OAuth 2.0, பிரிவு 2.3.1.
பிரிவு 4.2 இல் நிறுவப்பட்ட IANA "OAuth கிள்ளாக்கு எண்ட்பாயிண்ட் அங்கீகார முறைகள்" பதிவேட்டின் மூலம் கூடுதல் மதிப்புகளை வரையறுக்கலாம். முழுமையான URIகள் பதிவு செய்யப்படாமலேயே இந்த அளவுருவின் மதிப்புகளாகவும் பயன்படுத்தப்படலாம். குறிப்பிடப்படவில்லை அல்லது தவிர்க்கப்பட்டிருந்தால், இயல்புநிலை "client_secret_basic" ஆகும், இது OAuth 2.0 இன் பிரிவு 2.3.1 இல் குறிப்பிடப்பட்டுள்ள HTTP அடிப்படை அங்கீகாரத் திட்டத்தைக் குறிக்கிறது.
- token_endpoint_auth_signing_alg: str | None = None¶
JWS [JWS] அல்காரிதம் [JWA] கையொப்பமிட JWT [JWT] பயன்படுத்தப்பட வேண்டும், இது கிள்ளாக்கு எண்ட்பாயிண்டில் வாடிக்கையாளரை தனியார்_key_jwt மற்றும் client_secret_jwt அங்கீகார முறைகளுக்கு அங்கீகரிக்கப் பயன்படுகிறது. அனைத்தும் கிள்ளாக்கு Requests using these authentication முறைகள் from this Client MUST be rejected, if the JWT is not signed with this algorithm. சேவையகங்கள் RS256 ஐ ஆதரிக்க வேண்டும். மதிப்பு எதுவும் பயன்படுத்தப்படக்கூடாது. இயல்புநிலை, தவிர்க்கப்பட்டால், OP மற்றும் RP ஆல் ஆதரிக்கப்படும் எந்த அல்காரிதமும் பயன்படுத்தப்படும்.
- tos_uri: str | None = None¶
கிளையண்டிற்கான மனிதனால் படிக்கக்கூடிய பணி விதிமுறைகளை சுட்டிக்காட்டும் முகவரி சரம், இது கிளையண்டை அங்கீகரிக்கும் போது இறுதிப் பயனர் ஏற்றுக்கொள்ளும் இறுதிப் பயனருக்கும் கிளையண்டிற்கும் இடையிலான ஒப்பந்த உறவை விவரிக்கிறது.
அங்கீகார சேவையகம் இந்த URL வழங்கப்பட்டிருந்தால் இறுதிப் பயனருக்குக் காண்பிக்க வேண்டும். இந்தப் புலத்தின் மதிப்பு சரியான இணையப் பக்கத்தைக் குறிக்க வேண்டும். பிரிவு 2.2 இல் விவரிக்கப்பட்டுள்ளபடி, இந்தப் புலத்தின் மதிப்பு சர்வதேசமயமாக்கப்படலாம்.
- property trusted: bool¶
நம்பகமான வாடிக்கையாளர்களுக்கு ஒப்புதல் பக்கத்தை பயனர்களுக்குக் காட்ட வேண்டிய அவசியமில்லை.
TRUSTED_DOMAINS உள்ளமைவில் பட்டியலிடப்பட்டுள்ள டொமைன்களில் ஒன்றின் கிளையன்ட்_யூரி டொமைன் பொருந்தினால், வாடிக்கையாளர் நம்பகமானவர். ஆதரிக்கும்
- userinfo_encrypted_response_alg: str | None = None¶
பயனர் செய்தி பதில்களை குறியாக்க JWE [JWE] அல்காரிதம் [JWA] தேவை. கையொப்பமிடுதல் மற்றும் குறியாக்கம் இரண்டும் கோரப்பட்டால், பதில் கையொப்பமிடப்பட்டு பின்னர் குறியாக்கம் செய்யப்படும், இதன் விளைவாக [JWT] இல் வரையறுக்கப்பட்டுள்ளபடி Nested JWT ஆக இருக்கும். இயல்புநிலை, தவிர்க்கப்பட்டால், எந்த குறியாக்கமும் செய்யப்படவில்லை.
- userinfo_encrypted_response_enc: str | None = None¶
பயனர் செய்தி பதில்களை குறியாக்க JWE enc அல்காரிதம் [JWA] தேவை. userinfo_encrypted_response_alg குறிப்பிடப்பட்டிருந்தால், இயல்புநிலை userinfo_encrypted_response_enc மதிப்பு A128CBC-HS256 ஆகும். userinfo_encrypted_response_enc சேர்க்கப்படும் போது, userinfo_encrypted_response_alg ஐயும் வழங்க வேண்டும்.
- userinfo_signed_response_alg: str | None = None¶
பயனர் செய்தி பதில்களில் கையொப்பமிட JWS alg அல்காரிதம் [JWA] தேவை. இது குறிப்பிடப்பட்டால், பதில் JWT [JWT] வரிசைப்படுத்தப்பட்டு, JWS ஐப் பயன்படுத்தி கையொப்பமிடப்படும். இயல்புநிலை, தவிர்க்கப்பட்டால், பயன்பாடு/json உள்ளடக்க வகையைப் பயன்படுத்தி, UTF-8 [RFC3629] குறியிடப்பட்ட சாதொபொகு பொருளாக உரிமைகோரல்களை வழங்குவதற்கு UserInfo பதிலுக்கானது.
- class canaille.oidc.basemodels.Consent[source]¶
Bases:
Modelஒரு பயன்பாட்டிற்கு நீண்ட கால பயனர் ஒப்புதல்.
- class canaille.app.features.Features(app)[source]¶
Bases:
object- property has_account_lockability¶
பயனர் கணக்குகளை பூட்ட முடியுமா என்பதைக் குறிப்பிடவும்.
இது Canaille பயன்படுத்தும் பின்தளத்தைப் பொறுத்தது. 2.6 இன் கீழ் உள்ள OpenLDAP பதிப்புகளுக்கு மட்டுமே இது முடக்கப்பட்டுள்ளது.
- property has_captcha¶
CAPTCHA நற்பொருத்தம் இயக்கப்பட்டுள்ளதா என்பதைக் குறிப்பிடவும்.
இது
CANAILLE.CAPTCHA_ENABLEDஉள்ளமைவு அளவுருவால் கட்டுப்படுத்தப்படுகிறது, மேலும்captchaகூடுதல் தொகுப்பு நிறுவப்பட வேண்டும்.
- property has_email_confirmation¶
பயனர் மின்னஞ்சல் உறுதிப்படுத்தல் இயக்கப்பட்டுள்ளதா என்பதைக் குறிப்பிடவும்.
இது
CANAILLE.EMAIL_CONFIRMATIONஉள்ளமைவு அளவுருவால் கட்டுப்படுத்தப்படுகிறது.
- property has_fido¶
FIDO2/WebAuthn அங்கீகார காரணி இயக்கப்பட்டுள்ளதா என்பதைக் குறிப்பிடவும்.
இதற்கு
fidoகூடுதல் தொகுப்பு நிறுவப்பட வேண்டும், ஒரு கவிமொ பின்தளம் மற்றும் சாவாகைஉரை செயல்படுத்தப்பட வேண்டும். LDAP பின்தளம் ஆதரிக்கப்படவில்லை.
- property has_intruder_lockout¶
ஊடுருவும் நபர் பூட்டுதல் நற்பொருத்தம் இயக்கப்பட்டுள்ளதா என்பதைக் குறிப்பிடவும்.
இது
CANAILLE.ENABLE_INTRUDER_LOCKOUTஉள்ளமைவு அளவுருவால் கட்டுப்படுத்தப்படுகிறது.
- property has_oidc¶
OIDC நற்பொருத்தம் இயக்கப்பட்டுள்ளதா என்பதைக் குறிப்பிடவும்.
மற்ற பயன்பாடுகளுக்கான அங்கீகார சேவையகமாக Canaille ஐ உருவாக்க மற்றும் ஒருகைஉள் ஐ இயக்க இந்த நற்பொருத்தம் தேவை. இது
CANAILLE_OIDCஉள்ளமைவு அளவுருவால் கட்டுப்படுத்தப்படுகிறது, மேலும்oidcகூடுதல் தொகுப்பு நிறுவப்பட வேண்டும்.
- property has_otp¶
OTP அங்கீகரிப்பு காரணி இயக்கப்பட்டுள்ளதா என்பதைக் குறிப்பிடவும்.
இது
CANAILLE.OTP_METHODஉள்ளமைவு அளவுருவால் கட்டுப்படுத்தப்படுகிறது,otpகூடுதல் தொகுப்பு நிறுவப்பட வேண்டும், மேலும் OTP பண்புக்கூறுகளை ஆதரிக்க பின்தளம் தேவைப்படுகிறது.
- property has_password_recovery¶
கடவுச்சொல் மீட்பு நற்பொருத்தம் இயக்கப்பட்டுள்ளதா என்பதைக் குறிப்பிடவும்.
இது
CANAILLE.ENABLE_PASSWORD_RECOVERYஉள்ளமைவு அளவுருவால் கட்டுப்படுத்தப்படுகிறது.
- property has_registration¶
பயனர் கணக்கு பதிவு இயக்கப்பட்டுள்ளதா என்பதைக் குறிப்பிடவும்.
இது
CANAILLE.ENABLE_REGISTRATIONஉள்ளமைவு அளவுருவால் கட்டுப்படுத்தப்படுகிறது.
- property has_scim_client¶
SCIM கிளையன்ட் நற்பொருத்தம் இயக்கப்பட்டுள்ளதா என்பதைக் குறிப்பிடவும்.
Canaille ஐ வழங்குவதற்கான கிளையண்டாக மாற்ற இந்த நற்பொருத்தம் தேவை. இது
CANAILLE_SCIM.ENABLE_CLIENTஉள்ளமைவு அளவுருவால் கட்டுப்படுத்தப்படுகிறது, மேலும்scimகூடுதல் தொகுப்பு நிறுவப்பட வேண்டும்.
- property has_scim_server¶
SCIM சர்வர் நற்பொருத்தம் இயக்கப்பட்டுள்ளதா என்பதைக் குறிப்பிடவும்.
Canaille ஐ வழங்குவதற்கான சேவையகமாக மாற்ற இந்த நற்பொருத்தம் தேவை. இது
CANAILLE_SCIM.ENABLE_SERVERஉள்ளமைவு அளவுருவால் கட்டுப்படுத்தப்படுகிறது, மேலும்scimகூடுதல் தொகுப்பு நிறுவப்பட வேண்டும்.
- property has_smtp¶
அஞ்சல் அனுப்பும் நற்பொருத்தம் இயக்கப்பட்டுள்ளதா என்பதைக் குறிப்பிடவும்.
<canaille.app.features.Features.has_email_confirmation>`, மின்னஞ்சல் OTP கடவுச்சொற்களை அனுப்புதல் போன்றவற்றுக்கு :attr:`சரிபார்ப்புக்கு இந்த நற்பொருத்தம் தேவை.
- property has_trusted_hosts¶
Flask TRUSTED_HOSTS விருப்பம் இயக்கப்பட்டதா என்பதைக் குறிப்பிடவும்.
இது
TRUSTED_HOSTSஉள்ளமைவு அளவுருவால் கட்டுப்படுத்தப்படுகிறது.