> For the complete documentation index, see [llms.txt](https://ayakaleaf-pro.ayaka.space/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayakaleaf-pro.ayaka.space/on-premises/pl/konfiguracja/overleaf-toolkit/authentication/saml-authentication.md). # Uwierzytelnianie SAML Ta funkcja została opracowana przez [yu-i-i/overleaf-cep](https://github.com/yu-i-i/overleaf-cep). Oto kilka dokumentów dotyczących Twojej konfiguracji. ### Konfiguracja Wewnętrznie moduł SAML Overleaf używa [passport-saml](https://github.com/node-saml/passport-saml) biblioteki, większość poniższych opcji konfiguracji jest przekazywana do `passport-saml`. Jeśli masz problemy z konfiguracją SAML, warto przeczytać README dla `passport-saml` aby zorientować się, jakiej konfiguracji oczekuje. Zmienna środowiskowa `EXTERNAL_AUTH` jest wymagane, aby włączyć moduł uwierzytelniania SAML. Ta zmienna środowiskowa określa, które zewnętrzne metody uwierzytelniania są aktywowane. Wartością tej zmiennej jest lista. Jeśli lista zawiera `saml` to uwierzytelnianie SAML zostanie aktywowane. Na przykład: `EXTERNAL_AUTH=ldap saml` Podczas korzystania z metody uwierzytelniania SAML użytkownik jest przekierowywany do witryny uwierzytelniania dostawcy tożsamości (IdP). Jeśli IdP pomyślnie uwierzytelni użytkownika, w bazie danych użytkowników Overleaf jest sprawdzany rekord zawierający `samlIdentifiers` pole w następującej strukturze: ```json samlIdentifiers: [ { externalUserId: "...", providerId: "1", userIdAttribute: "..." } ] ``` Pole `externalUserId` musi odpowiadać wartości właściwości określonej przez `userIdAttribute` w profilu użytkownika zwróconym przez serwer IdP. Jeśli nie zostanie znaleziony pasujący rekord, baza danych jest przeszukiwana w poszukiwaniu użytkownika, którego główny adres e-mail odpowiada adresowi e-mail w profilu użytkownika IdP: * Jeśli taki użytkownik zostanie znaleziony, `hashedPassword` pole jest usuwane, aby wyłączyć uwierzytelnianie lokalne, a `samlIdentifiers` pole jest dodawane. * Jeśli nie zostanie znaleziony pasujący użytkownik, tworzony jest nowy użytkownik z adresem e-mail i `samlIdentifiers` z profilu IdP. **Uwaga:** Obecnie obsługiwany jest tylko jeden IdP SAML. Pole `providerId` w `samlIdentifiers` jest ustawione na `'1'`. #### Zmienne środowiskowe * `OVERLEAF_SAML_IDENTITY_SERVICE_NAME` * Nazwa wyświetlana usługi tożsamości, używana na stronie logowania (domyślnie: `Zaloguj się za pomocą IdP SAML`). * `OVERLEAF_SAML_USER_ID_FIELD` * Wartość tego atrybutu będzie używana przez Overleaf jako zewnętrzny identyfikator użytkownika, domyślnie `nameID`. * `OVERLEAF_SAML_EMAIL_FIELD` * Nazwa pola Email w profilu użytkownika, domyślnie `nameID`. * `OVERLEAF_SAML_FIRST_NAME_FIELD` * Nazwa pola firstName w profilu użytkownika, domyślnie `givenName`. * `OVERLEAF_SAML_LAST_NAME_FIELD` * Nazwa pola lastName w profilu użytkownika, domyślnie `lastName` * `OVERLEAF_SAML_UPDATE_USER_DETAILS_ON_LOGIN` * Jeśli ustawione na `true`, aktualizuje użytkownika `first_name` i `last_name` pole przy logowaniu i wyłącz formularz danych użytkownika na `/user/settings` stronę. * `OVERLEAF_SAML_ENTRYPOINT` **(wymagane)** * Adres URL punktu wejścia dla usługi tożsamości SAML. * Przykład: `https://idp.example.com/simplesaml/saml2/idp/SSOService.php` * Przykład Azure: `https://login.microsoftonline.com/8b26b46a-6dd3-45c7-a104-f883f4db1f6b/saml2` * `OVERLEAF_SAML_ISSUER` **(wymagane)** * Nazwa wystawcy. * `OVERLEAF_SAML_AUDIENCE` * Oczekiwany Audience odpowiedzi SAML, domyślnie wartość `OVERLEAF_SAML_ISSUER`. * `OVERLEAF_SAML_IDP_CERT` **(wymagane)** * Ścieżka do pliku zawierającego publiczny certyfikat dostawcy tożsamości, używany do weryfikacji podpisów przychodzących odpowiedzi SAML. Jeśli dostawca tożsamości ma wiele ważnych certyfikatów podpisujących, może to być tablica JSON ze ścieżkami do certyfikatów. * Przykład (jeden certyfikat): `/var/lib/overleaf/certs/idp_cert.pem` * Przykład (wiele certyfikatów): `["var/lib/overleaf/certs/idp_cert.pem", "/var/lib/overleaf/certs/idp_cert_old.pem"]` * `OVERLEAF_SAML_PUBLIC_CERT` * Ścieżka do pliku zawierającego publiczny certyfikat podpisujący, używany do osadzenia w żądaniach uwierzytelniania, aby IdP mógł zweryfikować podpisy przychodzącego żądania SAML. Jest wymagany podczas konfigurowania [punktu końcowego metadanych](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-SAML-Authentication#metadata-for-the-identity-provider) gdy strategia jest skonfigurowana z `OVERLEAF_SAML_PRIVATE_KEY`. W celu obsługi rotacji certyfikatów można podać tablicę JSON ze ścieżkami do certyfikatów. Przy podawaniu tablicy certyfikatów pierwszy wpis w tablicy powinien odpowiadać bieżącemu `OVERLEAF_SAML_PRIVATE_KEY`. Dodatkowe wpisy w tablicy można wykorzystać do opublikowania nadchodzących certyfikatów w IdP przed zmianą `OVERLEAF_SAML_PRIVATE_KEY`. * `OVERLEAF_SAML_PRIVATE_KEY` * Ścieżka do pliku zawierającego klucz prywatny w formacie PEM odpowiadający `OVERLEAF_SAML_PUBLIC_CERT` używany do podpisywania żądań uwierzytelniania wysyłanych przez passport-saml. * `OVERLEAF_SAML_DECRYPTION_CERT` * Ścieżka do pliku zawierającego publiczny certyfikat, używany do [punktu końcowego metadanych](https://github.com/yu-i-i/overleaf-cep/wiki/Extended-CE:-SAML-Authentication#metadata-for-the-identity-provider). * `OVERLEAF_SAML_DECRYPTION_PVK` * Ścieżka do pliku zawierającego klucz prywatny odpowiadający `OVERLEAF_SAML_DECRYPTION_CERT` który będzie używany do próby odszyfrowania wszystkich otrzymanych zaszyfrowanych asercji. * `OVERLEAF_SAML_SIGNATURE_ALGORITHM` * Opcjonalnie ustaw algorytm podpisu do podpisywania żądań; prawidłowe wartości to 'sha1' (domyślnie), 'sha256' (preferowany), 'sha512' (najbezpieczniejszy, sprawdź, czy Twój IdP go obsługuje). * `OVERLEAF_SAML_ADDITIONAL_PARAMS` * Słownik JSON dodatkowych parametrów zapytania, które mają być dodawane do wszystkich żądań. * `OVERLEAF_SAML_ADDITIONAL_AUTHORIZE_PARAMS` * Słownik JSON dodatkowych parametrów zapytania, które mają być dodawane do żądań „authorize”. * Przykład: `{"some_key": "some_value"}` * `OVERLEAF_SAML_IDENTIFIER_FORMAT` * Format identyfikatora nazwy, o który należy poprosić dostawcę tożsamości (domyślnie: `urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress`). Jeśli używasz `urn:oasis:names:tc:SAML:2.0:nameid-format:persistent`, upewnij się, że `OVERLEAF_SAML_EMAIL_FIELD` zmienna środowiskowa jest zdefiniowana. Jeśli `urn:oasis:names:tc:SAML:2.0:nameid-format:transient` jest wymagany, musisz także zdefiniować `OVERLEAF_SAML_ID_FIELD` zmienną środowiskową, którą można na przykład ustawić na adres e-mail użytkownika. * `OVERLEAF_SAML_ACCEPTED_CLOCK_SKEW_MS` * Czas przesunięcia w milisekundach akceptowalny między klientem a serwerem podczas sprawdzania znaczników czasu ważności warunków asercji OnBefore i NotOnOrAfter. Ustawienie -1 całkowicie wyłączy sprawdzanie tych warunków. Domyślnie 0. * `OVERLEAF_SAML_ATTRIBUTE_CONSUMING_SERVICE_INDEX` * `AttributeConsumingServiceIndex` atrybut do dodania do AuthnRequest, aby poinformować IdP, jaki zestaw atrybutów dołączyć do odpowiedzi ([link](http://blog.aniljohn.com/2014/01/data-minimization-front-channel-saml-attribute-requests.html)). * `OVERLEAF_SAML_AUTHN_CONTEXT` * Tablica JSON wartości formatu identyfikatora nazwy do żądania kontekstu uwierzytelniania. Domyślnie: `["urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport"]`. * `OVERLEAF_SAML_FORCE_AUTHN` * Jeśli `true`, początkowe żądanie SAML od dostawcy usługi określa, że IdP powinien wymusić ponowne uwierzytelnienie użytkownika, nawet jeśli ma on ważną sesję. * `OVERLEAF_SAML_DISABLE_REQUESTED_AUTHN_CONTEXT` * Jeśli `true`, nie żądaj określonego kontekstu uwierzytelniania. Na przykład możesz to ustawić na `true` aby zezwolić na dodatkowe konteksty, takie jak logowanie bez hasła (`urn:oasis:names:tc:SAML:2.0:ac:classes:X509`). Obsługa dodatkowych kontekstów zależy od Twojego IdP. * `OVERLEAF_SAML_AUTHN_REQUEST_BINDING` * Jeśli ustawione na `HTTP-POST`, zażąda uwierzytelnienia od IdP za pomocą wiązania HTTP POST, w przeciwnym razie domyślnie użyje HTTP-Redirect. * `OVERLEAF_SAML_VALIDATE_IN_RESPONSE_TO` * Jeśli `always`, wtedy InResponseTo będzie weryfikowane w przychodzących odpowiedziach SAML. * Jeśli `nigdy`, wtedy InResponseTo nie będzie weryfikowane (domyślnie). * Jeśli `ifPresent`, wtedy InResponseTo będzie weryfikowane tylko wtedy, gdy występuje w przychodzącej odpowiedzi SAML. * `OVERLEAF_SAML_WANT_ASSERTIONS_SIGNED` i `OVERLEAF_SAML_WANT_AUTHN_RESPONSE_SIGNED` * Gdy ustawione na `true` (domyślnie), Overleaf oczekuje, że asercje SAML, a także cała odpowiedź uwierzytelniania SAML, będą podpisane przez IdP. Gdy obie opcje są `false`, co najmniej jedna z asercji lub odpowiedź musi być podpisana. * `OVERLEAF_SAML_REQUEST_ID_EXPIRATION_PERIOD_MS` * Określa czas wygaśnięcia, po którym Request ID wygenerowany dla żądania SAML nie będzie ważny, jeśli zostanie zobaczony w odpowiedzi SAML w polu `InResponseTo` Domyślnie: 28800000 (8 godzin). * `OVERLEAF_SAML_LOGOUT_URL` * adres bazowy, na który wysyła się żądania wylogowania (domyślnie: `entryPoint`). * Przykład: `https://idp.example.com/simplesaml/saml2/idp/SingleLogoutService.php` * `OVERLEAF_SAML_ADDITIONAL_LOGOUT_PARAMS` * Słownik JSON dodatkowych parametrów zapytania, które mają być dodawane do żądań „logout”. * `OVERLEAF_SAML_IS_ADMIN_FIELD` i `OVERLEAF_SAML_IS_ADMIN_FIELD_VALUE` * Gdy obie zmienne środowiskowe są ustawione, proces logowania aktualizuje `user.isAdmin = true` jeśli profil zwrócony przez IdP SAML zawiera atrybut określony przez `OVERLEAF_SAML_IS_ADMIN_FIELD` i jego wartość pasuje do `OVERLEAF_SAML_IS_ADMIN_FIELD_VALUE` lub jest tablicą zawierającą `OVERLEAF_SAML_IS_ADMIN_FIELD_VALUE`, w przeciwnym razie `user.isAdmin` jest ustawiane na `false`. Jeśli którakolwiek z tych zmiennych nie jest ustawiona, status administratora jest ustawiany tylko na `true` podczas tworzenia użytkownika administratora w Launchpad. **Metadane dostawcy tożsamości** Obecna wersja Overleaf CE zawiera punkt końcowy do pobierania metadanych dostawcy usługi: `http://my-overleaf-instance.com/saml/meta` Dostawca tożsamości musi zostać skonfigurowany tak, aby rozpoznawał serwer Overleaf jako „dostawcę usługi”. Instrukcje, jak to zrobić, znajdziesz w dokumentacji swojego serwera SAML. Poniżej znajduje się przykład odpowiednich metadanych dostawcy usługi:
ol-meta.xml ``` MII... [skipped] MII... [skipped] urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress ```
Zwróć uwagę na certyfikaty, `AssertionConsumerService.Location`, `SingleLogoutService.Location` i `EntityDescriptor.entityID` i ustaw odpowiednio w konfiguracji IdP albo wyślij plik metadanych administratorowi IdP.
Przykładowy plik variables.env (minimum) 
OVERLEAF_APP_NAME="Our Overleaf Instance"

ENABLED_LINKED_FILE_TYPES=project_file,project_output_file,url

# Włącza generowanie miniatur za pomocą ImageMagick
ENABLE_CONVERSIONS=true

# Wyłącza wymaganie potwierdzenia e-maila
EMAIL_CONFIRMATION_DISABLED=true

## Nginx
# NGINX_WORKER_PROCESSES=4
# NGINX_WORKER_CONNECTIONS=768

## Ustaw dla TLS przez nginx-proxy
# OVERLEAF_BEHIND_PROXY=true
# OVERLEAF_SECURE_COOKIE=true

OVERLEAF_SITE_URL=http://my-overleaf-instance.com
OVERLEAF_NAV_TITLE=Nasza instancja Overleaf
# OVERLEAF_HEADER_IMAGE_URL=http://somewhere.com/mylogo.png
OVERLEAF_ADMIN_EMAIL=support@example.com

OVERLEAF_LEFT_FOOTER=[{"text": "Skontaktuj się z zespołem wsparcia", "url": "mailto:support@example.com"}]
OVERLEAF_RIGHT_FOOTER=[{"text":"Cześć, jestem po prawej stronie", "url":"https://github.com/yu-i-i/overleaf-cep"}]

OVERLEAF_EMAIL_FROM_ADDRESS=team@example.com
OVERLEAF_EMAIL_SMTP_HOST=smtp.example.com
OVERLEAF_EMAIL_SMTP_PORT=587
OVERLEAF_EMAIL_SMTP_SECURE=false
# OVERLEAF_EMAIL_SMTP_USER=
# OVERLEAF_EMAIL_SMTP_PASS=
# OVERLEAF_EMAIL_SMTP_NAME=
OVERLEAF_EMAIL_SMTP_LOGGER=false
OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH=true
OVERLEAF_EMAIL_SMTP_IGNORE_TLS=false
OVERLEAF_CUSTOM_EMAIL_FOOTER=Ten system jest obsługiwany przez dział x

OVERLEAF_PROXY_LEARN=true
NAV_HIDE_POWERED_BY=true

#################
##     SAML    ##
#################

EXTERNAL_AUTH=saml
OVERLEAF_SAML_ISSUER=MyOverleaf
OVERLEAF_SAML_IDENTITY_SERVICE_NAME='Zaloguj się za pomocą dostawcy SAML'
OVERLEAF_SAML_EMAIL_FIELD=Email
OVERLEAF_SAML_FIRST_NAME_FIELD=DisplayName
OVERLEAF_SAML_LAST_NAME_FIELD=DisplayName
OVERLEAF_SAML_ENTRYPOINT=http://localhost:18000/login/saml/authorize/admin/SAML_Overleaf
OVERLEAF_SAML_IDP_CERT=/var/lib/overleaf/certs/idp_cert.pem
OVERLEAF_SAML_SIGNATURE_ALGORITHM=
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://ayakaleaf-pro.ayaka.space/on-premises/pl/konfiguracja/overleaf-toolkit/authentication/saml-authentication.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.