# De handboek van &kleopatra;

Marc
Mutz

    marc@kdab.net

David
Faure
Ontwikkelaar
Steffen
Hansen

    &Steffen.Hansen.mail;

Ontwikkelaar
Matthias Kalle
Dalheimer
Ontwikkelaar
Jesper
Pedersen

    &Jesper.Pedersen.mail;

Ontwikkelaar
Daniel
Molkentin

    &Daniel.Molkentin.mail;

Ontwikkelaar

&Freek.de.Kruijf;
&GPLNotice;
2010-04-27
2.0.14

&kleopatra; is een hulpmiddel voor het beheer van X.509 en OpenPGP-certificaten.

KDE
Kapp
X509
OpenPGP
PGP
LDAP
gpg
gpgsm
certificaat

## Inleiding

&kleopatra; is het &kde; hulpmiddel voor het beheer van X.509 en OpenPGP-certificaten in de &gpg; sleutelkast en voor het ophalen van certificaten uit &ldap; en andere servers voor certificaten.

&kleopatra; kan gestart worden vanuit het menu van &kmail; Hulpmiddelen Certificatenbeheerder, evenals vanaf de commandoregel. Het &kleopatra; programma heeft de naam ``kleopatra``.

Dit programma is genoemd naar Cleopatra, een beroemde vrouwelijke Egyptische farao die leefde in de tijd van Julius Caesar, waarmee ze een kind had, Caesarion, niet erkent als zijn erfgenaam.

De naam is gekozen omdat dit programma zijn oorsprong heeft in een Ägypten Projects (Ägypten is Duits voor Egypte). &kleopatra; is de Duitse spelling van Cleopatra.

## Hoofdfuncties

### De lokale sleutelkast bekijken

De hoofd functie van &kleopatra; is het weergeven en bewerken van de inhoud van de lokale sleutelkast, wat gelijk is aan het concept sleutelring van &gpg;, hoewel men deze gelijkenis niet te veel moet doorzetten.

Het hoofdvenster is opgedeeld in het grote gebied voor het weergeven van de sleutels, die bestaat uit verschillende tabbladen, de menubalk en de zoekbalk bovenaan en een statusbalk onderaan.

Elke regel in de lijst met sleutels komt overeen met één certificaat, geïdentificeerd door de zogenaamde Onderwerp-&dn;. &dn; is een acroniem voor Distinguished Name, een hiërarchische identifier, in grote mate overeenkomend met een pad in een bestandssysteem met een ongebruikelijke syntaxis, waarvan verondersteld wordt dat deze een globaal unieke identiteit geeft aan een gegeven certificaat.

Om geldig te zijn en dus bruikbaar, moeten (publieke) sleutels door een &ca; (Certification Authority) ondertekend zijn. Deze ondertekeningen worden certificaten genoemd, maar de termen certificaat en (publieke) sleutel worden uitwisselbaar gebruikt en we zullen ze ook niet in deze handleiding van elkaar onderscheiden, behalve wanneer expliciet genoemd.

&ca;'s moeten op hun beurt worden getekend door andere &ca;'s om geldig te zijn. Natuurlijk moet dit ergens eindigen, dus tekent de &ca; op het topniveau (root-&ca;) zijn sleutel met zichzelf (dit wordt zelftekenen genoemd). Root-certificaten moeten dus handmatig geldigheid toegekend worden (gewoonlijk vertrouwen genoemd), &eg; na vergelijking van de vingerafdruk met die op de website van de &ca;. Dit wordt typisch gedaan door de systeembeheerder of de verkoper van een product dat certificaten gebruikt, maar kan ook gedaan worden door de gebruiker via het commandoregelinterface van &gpgsm;.

Om te zien welke van de certificaten root-certificaten zijn, schakelt u om naar de hiërarchische modus voor de sleutellijst met .

U kunt de details zien van elk certificaat door er dubbel op te klikken of te gebruiken. Deze opent een dialoog die de meest gebruikelijke eigenschappen van het certificaat toont, zijn ketting met certificaten (&ie; de ketting van uitgevers tot op de root-&ca;) en een dump van alle informatie die de backend uit het certificaat kan halen.

Als u de sleutelkast wijzigt zonder &kleopatra; te gebruiken (&eg; met het commandoregelinterface van &gpgsm;), dan kunt u het beeld vernieuwen met .

### Zoeken en importeren van certificaten

Meestal zult u nieuwe certificaten verkrijgen door handtekeningen in e-mails te verifiëren, omdat certificaten meestal ingebed zijn in de gemaakte handtekeningen. Wanneer u echter een e-mail naar iemand moet zenden, waarmee u nog geen contact hebt gehad, dan moet u het certificaat uit een &ldap;-map (hoewel &gpgsm; dit automatisch kan doen) ophalen of uit een bestand. U moet ook uw eigen certificaat importeren na het ontvangen van het antwoord van de &ca; op uw verzoek om een certificaat.

Om te zoeken naar een certificaat in een &ldap;-directory, selecteert u Bestand Certificaten op server opzoeken en voert u enige tekst in (&eg; de naam van de persoon waarvan u het certificaat wilt) in het tekstinvoervak van de dialoog Certificaten opzoeken op de sleutelserver, klik daarna op de knop Zoeken. De resultaten worden getoond in de lijst met sleutels onder de zoekbalk, waar u certificaten selecteert om ze beter te bekijken door te klikken op de knop Details of ze download met Importeren in de lokale sleutelkast.

U kunt de lijst met &ldap;-servers instellen voor het zoeken in de pagina Directory Services van de instellingendialoog van &kleopatra;.

Als u het certificaat als een bestand ontvangt, probeer dan . &gpgsm; moet het formaat van het certificaatbestand begrijpen; kijk in de handleiding van &gpgsm; voor een lijst van ondersteunde bestandsformaten.

Als u uw eigen sleutelpaar met &gpgsm; aanmaken niet hebt uitgevoerd, dan moet u ook handmatig de publieke sleutel (evenals de geheime sleutel) importeren uit het PKCS#12-bestand dat u van de &ca; ontving. U kunt dit op de commandoregel doen met ``kleopatra `--import-certificate` `bestandsnaam``` of in &kleopatra; met , zoals u ook zou doen met normale certificaten.

### Nieuwe sleutelparen aanmaken

Het menuitem start de Assistent voor certificaat aanmaken die u door een aantal stappen voor het aanmaken van een certificaatverzoek.

Wanneer u klaar bent met een stap in de assistent, druk dan op Volgende om naar de volgende stap (of Terug om stappen te herzien die al zijn voltooid). Het maken van het certificaatverzoek kan op elk moment worden geannuleerd door op de knop Annuleren te drukken.

Op de eerste pagina van de assistent kiest u welk type certificaat u wilt aanmaken:

Een persoonlijk OpenPGP-sleutelpaar aanmaken

  OpenPGP sleutelparen worden lokaal aangemaakt en gecertificeerd door uw vrienden en bekenden. Er is geen centrale certificatieautoriteit; in plaats daarvan kan elk individu een persoonlijk "Web van vertrouwen" door andere sleutelparen te certificeren met zijn eigen certificaat.

  U moet een Naam, E-mailadres en optioneel Commentaar invoeren.

Een persoonlijk X.509-sleutelpaar en certificatieverzoek aanmaken

  X.509 sleuteparen worden lokaal aangemaakt, maar centraal gecertificeerd door een certificatieautoriteit (&ca;). Een &ca; kan een andere &ca; certificeren, waardoor een centrale, hiërarchische keten van vertrouwen ontstaat.

  De volgende stap in de assistent is het invoeren van uw persoonlijke gegevens voor het certificaat. De in te vullen velden zijn:

  - Algemene naam/Common Name (CN): Uw naam;

  - E-mailadres (EMAIL): Uw e-mailadres; let er goed op dat dit juist is—dit zal worden gebruikt als het adres waar mensen e-mail naar zenden wanneer ze uw certificaat gebruiken.

  - Locatie (L): Het dorp of de stad waarin u woont;

  - Organizational unit (OU): De eenheid in uw organisatie waarin u zich bevindt (bijvoorbeeld, "Administratie");

  - Organisatie (O): De organisatie die u vertegenwoordigt (bijvoorbeeld, het bedrijf waarvoor u werkt);

  - Country code/landencode (C): De tweeletterige code voor het land waarin u woont (bijvoorbeeld, "NL");

  De volgende stap in de assistent is het selecteren of het certificaat in een bestand moet worden opgeslagen of direct verzenden naar een &ca;. U zult de bestandsnaam of het e-mailadres, waarnaar het certificaatverzoek verzonden moet worden, moeten specificeren.

## Menureferentie

### Menu Bestand

&Ctrl;N Bestand Nieuw certificaat...

  Maakt een nieuw sleutelpaar (publiek en privé) aan en stelt u in staat om het publieke deel naar een certificatieautoriteit te sturen (&ca;) ter certificering. Het resulterende certificaat wordt dan naar u teruggezonden of opgeslagen in een &ldap;-server zodat u het kunt downloaden in uw lokale sleutelkast, waar u het kan gebruiken om te signeren en e-mails te ontcijferen.

  Deze manier van werken wordt gedecentraliseerde sleutelgeneratie genoemd, omdat alle sleutels lokaal worden aangemaakt. &kleopatra; (en &gpgsm;) ondersteunen geen directe gecentraliseerde sleutelgeneratie, maar u kunt het publieke/geheime sleutelpaar dat u ontvangt van de &ca; in het formaat PKCS#12 via importeren.

&Ctrl;&Shift;I Bestand Certificaten opzoeken op de server...

  Zoekt naar en importeert certificaten op servers voor certificaten naar de lokale sleutelkast. Zie voor details.

  U moet servers voor certificaten hebben geconfigureerd om dit te laten werken. Zie voor meer details.

&Ctrl;I Bestand Certificaten importeren...

  Importeert certificaten en/of geheime sleutels uit bestanden in de lokale sleutelkast. Zie voor details.

  Het formaat van het certificaat moet worden ondersteund door &gpgsm;/&gpg;. Kijk in de handleiding van &gpgsm; en &gpg; voor een lijst van ondersteunde bestandsformaten.

&Ctrl;E Bestand Certificaten exporteren...

  Exporteert de geselecteerde certificaten naar een bestand.

  De extensie van de bestandsnaam die u koos voor het exporteren bepaalt het formaat van het exportbestand:

  - Voor OpenPGP certificaten, resulteren `gpg` en `pgp` in een binair bestand, terwijl `asc` resulteert in een &ascii; file.

  - Voor &smime; certificaten, resulteert `der` in een binair, &der;-gecodeerd bestand, terwijl `pem` resulteert in een &ascii; bestand.

  Tenzij meerdere certificaten zijn geselecteerd, zal &kleopatra; `vingerafdruk.{asc,pem}` als de naam van het te exporteren bestand voorstellen.

  Deze functie is alleen beschikbaar wanneer een of meer certificaten zijn geselecteerd.

  Deze functie exporteert alleen de publieke sleutels, zelfs als de geheime sleutel beschikbaar is . Gebruik om zowel de publieke als de geheime sleutels in een bestand te exporteren, maar let er op dat dat bijna altijd een slecht idee is.

Bestand Geheim sleutels exporteren...

  Exporteert beiden, de publieke en geheime sleutel, naar een bestand.

  In de geopende dialoog kunt u een Uitvoerbestandsnaam kiezen, en of een binair of &ascii;-bestand (ASCII-bewapend) voor export moet worden aangemaakt. Bij exporteren van &smime; geheime sleutels kunt u ook de Tekenset van de wachtwoordzin kiezen. Zie de discussie van de optie `--p12-charset tekenset` in het handboek van &gpgsm; voor meer details.

  Deze functie is alleen beschikbaar wanneer precies één certificaat is geselecteerd en de geheime sleutel voor dat certificaat beschikbaar is.

  Het zou zelden nodig moeten zijn om deze functie te gebruiken, en als dat zo is, dan zou het zorgvuldig gepland moeten worden. De migratie van een geheime sleutel bevat een keuze van het transportmedium en de veilige verwijdering van de sleutelgegevens op de oude machine, evenals die onder andere op het transportmedium.

&Ctrl;&Shift;E Bestand Certificaten naar server exporteren...

  Publiceer de geselecteerde certificaten op een sleutelserver (alleen &openpgp;).

  Het certificaat wordt verzonden naar de server voor certificaten geconfigureerd voor &openpgp; (cf. ), als die is ingesteld, anders naar keys.gnupg.net.

  Deze functie is alleen beschikbaar als minstens een &openpgp; (en geen &smime;) certificaten zijn geselecteerd.

  Wanneer OpenPGP-certificaten naar een publieke directory-server geëxporteerd zijn, is het bijna onmogelijk om ze weer te verwijderen. Maak een intrekkingscertificaat aan, voordat u uw certificaten naar de publieke directory-server exporteert, zodat u ze indien nodig later weer kan intrekken.

  De meeste publieke &openpgp; servers voor certificaten synchroniseren deze onder elkaar, zodat er weinig reden is ze naar meer dan een server te sturen.

  Het kan zijn dat zoeken op een certificatenserver geen resultaten oplevert zelfs als u zojuist uw certificaat daarheen hebt opgestuurd. Dit is vanwege het feit dat publieke sleutelserveradressen round-robin uit de DNS-server komen om de belasting te balanceren over meerdere machines. Deze machines synchroniseren zich met elkaar, maar gewoonlijk slechts ongeveer elke 24 uur.

Bestand Ontcijfer/verifieer bestanden...

  Ontcijfert bestanden en/of verifieert handtekeningen over bestanden.

Bestand Onderteken/versleutel bestanden...

  Ondertekent en/of versleutelt bestanden.

&Ctrl;W Bestand Sluiten

  Sluit het hoofdvenster van &kleopatra;. U kunt het op elk moment herstellen met het pictogram in het systeemvak.

&Ctrl;Q Bestand Afsluiten

  &kleopatra; wordt beëindigd.

### Menu Beeld

F5 Beeld Opnieuw tonen

  Ververst de certificatenlijst.

  Het gebruik van deze functie is gewoonlijk niet nodig, omdat &kleopatra; het bestandssysteem monitort op wijzigingen en automatisch de certificatenlijst ververst indien nodig.

&Esc; Beeld Bewerking stoppen

  Stopt (annuleert) alle gaande acties, &eg; een zoekopdracht, lijst met sleutels tonen of een download.

  Deze functie is alleen beschikbaar als minstens een actie actief is.

  Vanwege beperkingen in de backend, hangen bewerkingen soms op zo'n manier dat deze functie ze niet direct kan annuleren of zelfs helemaal niet.

  In zulke gevallen is de enige manier om de orde te herstellen het killen van de processen &scdaemon;, &dirmngr;, &gpgsm; en &gpg;, in die volgorde, via de systeemhulpmiddelen (`top`, venstertakenbeheerder, &etc;), totdat de bewerking niet geblokkeerd is.

Beeld Details van certificaat

  Toont de details van het geselecteerde certificaat.

  Deze functie is alleen beschikbaar wanneer precies één certificaat is geselecteerd.

  Deze functie is ook beschikbaar door direct te dubbelklikken op het overeenkomstige item in de getoonde lijst.

Beeld Hiërarchische certificatenlijst

  Wisselt tussen een hiërarchische en platte modus van de certificatenlijst.

  In de hiërarchische modus zijn certificaten gerangschikt in de relatie uitgever/onderwerp, zodat is gemakkelijk is te zien tot welke hiërarchie een gegeven certificaat behoort, maar een gegeven certificaat is initieel moeilijker te vinden (hoewel u natuurlijk de zoekbalk kunt gebruiken).

  In platte modus worden alle certificaten in een platte lijst getoond, alfabetisch gesorteerd. In deze modus is een gegeven certificaat gemakkelijk te vinden, maar het is niet direct duidelijk tot welk root-certificaat het behoort.

  Deze functie wisselt de hiërarchische modus per tabblad, &ie; elk tabblad heeft zijn eigen hiërarchiestatus. Dit is omdat u zowel een platte als een hiërarchische lijst bij hand kunt hebben, elk in zijn eigen tabblad.

  Hiërarchische weergave is nu alleen geïmplementeerd voor &smime;-certificaten. Er is onder de ontwikkelaars onenigheid over de juiste manier om &openpgp;-certificaten hiërarchisch weer te geven (in wezen, ouder &equals; ondertekenaar of ouder &equals; ondertekende).

&Ctrl;. Beeld Alles uitvouwen

  Vouwt alle items in de lijst in de lijstweergave van de certificaten uit, &ie; maakt alle items zichtbaar.

  Dit is de standaard bij het binnengaan in de modus hiërarchische sleutellijst.

  U kunt natuurlijk nog steeds elk individueel item invouwen of uitklappen.

  Deze functie is alleen beschikbaar wanneer aan is.

&Ctrl;, Beeld Alles invouwen

  Vouwt alle items in de lijst met certificaten in, &ie; verbergt alles behalve het bovenste gedeelte van de items.

  U kunt natuurlijk nog steeds elk individueel item invouwen of uitklappen.

  Deze functie is alleen beschikbaar wanneer aan is.

### Menu met certificaten

Certificaten Eigenaarvertrouwen wijzigen...

  Wijzigt het vertrouwen in de eigenaar van het geselecteerde &openpgp;-certificaat.

  Deze functie is alleen beschikbaar wanneer precies één &openpgp;-certificaat is geselecteerd.

Certificaten Hoofdcertificaat vertrouwen

  Markeert dit (&smime;)-hoofdcertificaat als vertrouwd.

  Op een bepaalde manier is dit het equivalent van voor &smime;-hoofdcertificaten. U kunt echter alleen kiezen tussen—in &openpgp; termen—volledig vertrouwen en geen vertrouwen.

  De backend (via &gpgagent;) zal op het moment van het importeren van het hoofdcertificaat of het geïmporteerde hoofdcertificaat is te vertrouwen. Die functie moet expliciet worden ingeschakeld in instellingen van de backend (`allow-mark-trusted` in `gpg-agent.conf` of ofwel GnuPG-systeem GPG-agent Sta clients toe om sleutels als "vertrouwd" te markeren ofwel S/MIME-validatie Sta toe hoofdcertificaten als vertrouwd te markeren onder ).

  Die functionaliteit in de backend inschakelen kan leiden tot popups van &pinentry; op ongewenste tijden (&eg; bij het verifiëren van handtekeningen) en kan dus onbewaakte e-mailverwerking blokkeren. Daarom en omdat het gewenst is om in staat te zijn een vertrouwd hoofdcertificaat opnieuw te wantrouwen, staat &kleopatra; handmatig instellen van vertrouwen toe.

  Vanwege het ontbreken van ondersteuning voor deze functie door een backend, is het nodig dat &kleopatra; direct op de vertrouwensdatabase (`trustlist.txt`) van &gpgsm; werkt. Bij het gebruiken van deze functie moet u er zeker van zijn dat er geen andere versleutelingsbewerkingen bezig zijn die concurreren met &kleopatra; voor wijzigingen in die database.

  Deze functie is alleen beschikbaar wanneer precies één &smime;-hoofdcertificaat is geselecteerd en dat certificaat nog niet vertrouwd wordt.

  Gebruik om deze functie ongedaan te maken.

Certificaten Wantrouw hoofdcertificaat

  Markeert dit &smime;-hoofdcertificaat als niet vertrouwd.

  Deze functie is alleen beschikbaar wanneer precies één &smime;-hoofdcertificaat is geselecteerd en dat certificaat wordt nu vertrouwd.

  Gebruikt om ongedaan te maken. Zie aldaar voor details.

Certificaten Certificeer certificaat...

  Stelt u in staat om een ander &openpgp;-certificaat te certificeren.

  Deze functie is alleen beschikbaar als precies één &openpgp;-certificaat is geselecteerd.

Certificaten Vervaldatum wijzigen...

  Stelt u in staat om de vervaldatum van uw &openpgp;-certificaat te wijzigen.

  Gebruik deze functie om de leeftijd van uw &openpgp;-certificaten, als alternatief voor ofwel een nieuwe aanmaken of een onbeperkte leeftijd te gebruiken (vervalt nooit).

  Deze functie is alleen beschikbaar als precies één certificaat is geselecteerd en de geheime sleutel voor dat certificaat beschikbaar is.

Certificaten Wachtwoordzin wijzigen...

  Stelt u in staat om de wachtwoordzin van uw geheime sleutel te wijzigen.

  Deze functie is alleen beschikbaar als precies één certificaat is geselecteerd en de geheime sleutel beschikbaar is voor dat certificaat. Het vereist een erg recente backend, omdat we de implementatie van het direct aanroepen van &gpg; en &gpgsm; hebben gewijzigd tot een op &gpgme; gebaseerde.

  Uit veiligheidsredenen, wordt zowel de oude als de nieuwe wachtwoordzin gevraagd door &pinentry;, een separaat proces. Afhankelijk van het platform waarop u werkt en de kwaliteit van de implementatie van &pinentry; op dat platform, kan het zijn dat het venster van &pinentry; opkomt in de achtergrond. Dus als u deze functie selecteert en er gebeurt niets, controleer dan taakbalk van het besturingssyteem in geval een venster van &pinentry; geopend is in de achtergrond.

Certificaten Gebruikers-id toevoegen...

  Stelt u in staat om een nieuwe gebruikers-id aan uw &openpgp;-certificaat toe te voegen.

  Gebruik dit om nieuwe identiteiten aan een bestaand certificaat toe te voegen als alternatief voor het aanmaken van een nieuw sleutelpaar. Een &openpgp; gebruikers-id heeft de volgende vorm:

      Echte naam (Commentaar) <E-mailadres>

  In de dialoog die verschijnt wanneer u deze functie selecteert, zal &kleopatra; u apart vragen naar elk van de drie parameters (Echte naam, Commentaar en E-mailadres) en het resultaat aan u tonen.

  Deze parameters zijn onderworpen aan dezelfde beheerdersbeperkingen als in nieuwe certificaten. Zie en voor details.

  Deze functie is alleen beschikbaar als precies één &openpgp;-certificaat is geselecteerd en de geheime sleutel voor dat certificaat beschikbaar is.

Del Certificaten Verwijderen

  Verwijdert de geselecteerde certificaten uit de lokale sleutelring.

  Gebruik deze functie om ongebruikte sleutels uit uw lokale sleutelkast te verwijderen. Certificaten zijn typisch vastgemaakt aan ondertekende e-mails, verifiëren van een e-mail kan er in resulteren dat de zojuist verwijderde weer de kop op steekt in de lokale sleutelkast. Het is dus waarschijnlijk het beste om deze functie zo min mogelijkheid te gebruiken. Als u zich verloren voelt, gebruik dan de zoekbalk of de functie om de controle terug te krijgen over de meeste certificaten.

  Er is één uitzondering op het bovenstaande: Als u een van uw eigen certificaten verwijdert, dan verwijdert u daarmee ook de geheime sleutel. Dat betekent dat u niet in staat zult zijn om vroeger met dit certificaat versleutelde communicatie te lezen, tenzij u nog ergens een reservekopie hebt.

  &kleopatra; zal u waarschuwen wanneer u een geheime sleutel probeert te verwijderen.

  Vanwege de hiërarchische natuur van &smime;-certificaten is het zo dat, als u een &smime;-certificaat van een uitgever (&ca;-certificaat) verwijdert, alle afgeleiden ook worden verwijderd. Dit is hetzelfde als een bestandssysteem: wanneer u een map verwijdert, verwijdert u ook alle bestanden en mappen erin.

  Natuurlijk is deze functie alleen beschikbaar als u minstens één certificaat hebt geselecteerd.

Certificaten Certificaat dumpen

  Toont alle informatie die &gpgsm; heeft over het geselecteerde (&smime;-) certificaat.

  Zie de discussie over `--dump-key sleutel` in het handboek van &gpgsm; voor details over de uitvoer.

### Menu hulpmiddelen

Hulpmiddelen GnuPG-logweergave...

  Start &kwatchgnupg;, een hulpmiddel om de debuguitvoer van &gnupg; toepassingen te tonen. Als ondertekenen, versleutelen of verifiëren mysterieus stop met werken, dan kunt misschien vinden waarom door in de log te kijken.

  Deze functie is niet beschikbaar onder Windows, omdat de onderliggende mechanismen niet in de backend op dat platform zijn geïmplementeerd.

Hulpmiddelen OpenPGP-certificaten verversen

  Alle &openpgp;-certificaten verversen door het uitvoeren van

      gpg --refresh-keys

  Na succesvolle uitvoering van het commando, bevat uw lokale sleutelbos de laatste wijzigingen met betrekking tot de geldigheid van &openpgp;-certificaten.

  Zie de opmerking onder voor enige valkuilen.

Hulpmiddelen X.509-certificaten verversen

  Alle &smime;-certificaten verversen door het uitvoeren van

      gpgsm -k --with-validation --force-crl-refresh --enable-crl-checks

  Na succesvolle uitvoering van het commando bevat uw lokale sleutelbos de laatste wijzigingen met betrekking tot de geldigheid van &smime;-certificaten.

  Het verversen van &x509; of &openpgp; certificaten houdt in het downloaden van alle certificaten en &crl;'s, om te controleren of ze intussen zijn ingetrokken.

  Dit kan een zware belasting zijn voor uw eigen en andermans netwerk en kan meer dan een uur duren, afhankelijk van de netwerkverbinding en het aantal te controleren certificaten.

Hulpmiddelen CRL uit een bestand importeren...

  Laat u handmatig &crl;'s uit bestanden importeren.

  Normaal worden 'Certificate Revocation Lists' (&crl;'s) transparent afgehandeld door de backend, maar soms kan het nuttig zijn om een &crl; handmatig te importeren in de lokale &crl;-cache.

  Om het importeren van &crl; te laten werken moet het hulpmiddel &dirmngr; in `PATH` zijn te vinden. Als dit menu-item is uitgeschakeld, dan zou u contact met de systeembeheerder moeten opnemen en hem vragen &dirmngr; te installeren.

Hulpmiddelen CRL-cache wissen

  Wist de CRL-cache van &gpgsm;.

  U hebt dit waarschijnlijk nooit nodig. U kunt het verversen van de CRL-cache forceren door alle certificaten te selecteren en in plaatst daarvan te gebruiken.

Hulpmiddelen CRL-cache dumpen

  Toont de gedetailleerde inhoud van de CRL-cache van &gpgsm;.

### Menu Instellingen

Instellingen Zelftest uitvoeren

  Een set zelftesten uitvoeren en hun resultaat laten zien.

  Dit is dezelfde set testen die bij opstarten standaard worden uitgevoerd. Als u de zelftesten bij opstarten hebt uitgeschakeld, dan kunt u ze hier weer aanzetten.

Instellingen Getoonde werkbalken

  &kleopatra; werkbalken tonen/verbergen.

  &kleopatra; heeft twee werkbalken:

  1. Hoofdwerkbalk

     Deze werkbalk bevat een selectie van algemene functies. U kunt instellen welke functies u hier wilt zien met .

  2. Zoekbalk

     Deze werkbalk bevat de zoek- en filterbesturing.

Instellingen Statusbalk tonen

  Schakelt de zichtbaarheid van de onderste statusbalk aan/uit.

Instellingen Sneltoetsen instellen...

  Opent de standaard &kde; sneltoetsen-configuratie-dialoog, waarmee u sneltoetsen kunt definiëren en verwijderen voor alle menu-items.

Instellingen Werkbalken instellen...

  Opent de standaard dialoog voor het configureren van de &kde;-werkbalk, waarin u kunt kiezen welke acties in de werkbalken van &kleopatra; moeten komen.

Instellingen &kleopatra; instellen...

  Opent de configuratiedialoog van &kleopatra;.

  Zie voor details.

### Venstermenu

Het menu Venster stelt u in staat om de tabbladen te beheren. Met de items in dit menu kunt u een tabblad hernoemen, toevoegen, het huidige tabblad dupliceren, sluiten en naar links of rechts verplaatsen.

Door met de &RMB; op een tabblad te klikken opent u een contextmenu, waarin u ook dezelfde acties kunt selecteren.

### Menu Help

Het menu Help bevat het standaard &kde;-helpmenu.

&help.menu.documentation;

## Naslag van opties op de commandoregel

Alleen de opties die specifiek zijn voor &kleopatra; worden hier weergegeven. Zoals met alle &kde;-toepassingen, kunt u een complete lijst met opties krijgen met het commando ``kleopatra `--help```.

`--external`

  Alleen UI-server uitvoeren, hoofdvenster verbergen

`-p` `--openpgp`

  OpenPGP voor de volgende actie gebruiken

`-c` `--cms`

  CMS (X.509, S/MIME) voor de volgende actie gebruiken

`-i` `--import-certificate`

  Specificeert een bestand of &URL; waar vandaan certificaten (of geheime sleutels) geïmporteerd moeten worden.

  Dit is het equivalent op de commandoregel van .

`-e` `--encrypt`

  Bestand(en) versleutelen

`-s` `--sign`

  Bestand(en) ondertekenen

`-E` `--encrypt-sign`

  Versleutel en/of onderteken bestand(en). Zelfde als `--sign-encrypt`, niet gebruiken

`-d` `--decrypt`

  Bestand(en) ontcijferen

`-V` `--verify`

  Bestand/ondertekening verifiëren

`-D` `--decrypt-verify`

  Bestand(en) ontcijferen en/of verifiëren

## &kleopatra; instellen

De dialoog voor instellen van &kleopatra; is toegankelijk via .

Elk van zijn pagina's wordt in de secties hieronder beschreven.

### Directory Services instellen

Op deze pagina kunt u instellen welke &ldap;-servers te gebruiken voor het zoeken naar &smime;-certificaten en welke sleutelservers te gebruiken voor zoeken naar &openpgp;-certificaten.

Dit is eenvoudig een meer gebruikersvriendelijke versie van dezelfde instellingen die u ook vindt in . Alles wat u hier in kan stellen, kunt u ook daar instellen.

#### Een opmerking over Proxy-instellingen

Proxy settings can be configured for &http; and &ldap; in , but only for &gpgsm;. For &gpg;, due to the complexity of keyserver options in &gpg; and lack of proper support for them in &gpgconf;, you currently need to modify the config file `gpg.conf` directly. Please refer to the &gpg; manual for details. &kleopatra; will preserve such settings, but does not yet allow to modify them in the &GUI;.

The Directory services table shows which servers are currently configured. Double-click on a cell in the table to change parameters of existing server entries.

De betekenis van de kolommen in de tabel is als volgt:

Schema

  Determines the network protocol which is used to access the server. Often-used schemes include ldap (and its &ssl;-secured sibling ldaps) for &ldap; servers (common protocol for &smime;; the only one supported by &gpgsm;), and hkp, the Horowitz Keyserver Protocol, nowadays usually &http; Keyserver Protocol, a &http;-based protocol that virtually all public &openpgp; keyservers support.

  Kijk in de handleiding van &gpg; en &gpgsm; voor een lijst van ondersteunde schema's.

Servernaam

  The domain name of the server, &eg; keys.gnupg.net.

Poort van server

  De netwerkpoort waarop de server luistert.

  This changes automatically to the default port when you change the , unless it was set to some non-standard port to begin with. If you changed the default port and cannot get it back, try setting to `http` and to `80` (the default for &http;), then take it from there.

Base DN

  The Base-&dn; (only for &ldap; and &ldaps;), &ie; the root of the &ldap; hierarchy to start from. This is often also called search root or search base.

  It usually looks like `c=de,o=Foo`, given as part of the &ldap; &URL;.

Gebruikersnaam

  The user name, if any, to use for logging into the server.

  This column is only shown if the option Show user and password information (below the table) is checked.

Wachtwoord

  The password, if any, to use for logging into the server.

  This column is only shown if the option Show user and password information (below the table) is checked.

X.509

  Check this column if this entry should be used for &x509; (&smime;) certificate searches.

  Only &ldap; (and &ldaps;) servers are supported for &smime;.

OpenPGP

  Check this column if this entry should be used for &openpgp; certificate searches.

You can configure as many &smime; (&x509;) servers as you want, but only one &openpgp; server is allowed at any time. The &GUI; will enforce this.

To add a new server, click on the New button. This duplicates the selected entry, if any, or else inserts a default &openpgp; server. Then you can set the , the , the , and the usual and , both of which are only needed if the server requires authentication.

To directly insert an entry for &x509; certificates, use New X.509; use New OpenPGP for &openpgp;.

To remove a server from the search list, select it in the list, then press the Delete button.

To set the &ldap; timeout, &ie; the maximum time the backend will wait for a server to respond, simply use the corresponding input field labeled LDAP timeout (minutes:seconds).

If one of your servers has a large database, so that even reasonable searches like `Smith` hit the maximum number of items returned by query, you might want to increase this limit. You can find out easily if you hit the limit during a search, since a dialog box will pop up in that case, telling you that the results have been truncated.

Some servers may impose their own limits on the number of items returned from a query. In this case, increasing the limit here will not result in more returned items.

### Configuring Appearance

#### Configuring Tooltips

In the main certificate list, &kleopatra; can show details about a certificate in a tooltip. The information displayed is the same as in the Overview tab of the Certificate Details dialog. Tooltips, however, can be restricted to show only a subset of information for a less verbose experience.

The Key-ID is always shown. This is to ensure that tooltips for different certificates do, in fact, differ (this is especially important if only has been selected).

You can independently enable or disable the following information sets:

Geldigheid tonen

  Shows information about the validity of a certificate: its current status, issuer-&dn; (&smime; only), expiry dates (if any) and certificate usage flags.

  Voorbeeld:

      This certificate is currently valid.
      Issuer:            CN=Test-ZS 7,O=Intevation GmbH,C=DE
      Validity:          from 25.08.2009 10:42 through 19.10.2010 10:42
      Certificate usage: Signing EMails and Files, Encrypting EMails and Files
      Key-ID:            DC9D9E43

Eigenaarsinformatie tonen

  Shows information about the owner of the certificate: subject-&dn; (&smime; only), user-IDs (including emails addresses) and ownertrust (&openpgp; only).

  &openpgp; example:

      User-ID:           Gpg4winUserA <gpg4winusera@test.hq>
      Key-ID:            C6BF6664
      Ownertrust:        ultimate

  &smime; example:

      Subject:           CN=Gpg4winTestuserA,OU=Testlab,O=Gpg4win Project,C=DE
      a.k.a.:            Gpg4winUserA@test.hq
      Key-ID:            DC9D9E43

Technische details tonen

  Shows technical information about the certificate: serial number (&smime; only), type, fingerprint and storage location.

  Voorbeeld:

      Serial Number:     27
      Certificate type:  1,024-bit RSA (secret certificate available)
      Key-ID:            DC9D9E43
      Fingerprint:       854F62EEEBB41BFDD3BE05D124971E09DC9D9E43
      Stored:            on this computer

#### Certificaatcategorieën instellen

&kleopatra; allows you to customize the appearance of certificates in the list view. This includes showing a small icon, but you can also influence the foreground (text) and background colors, as well as the font.

Each certificate category in the list is assigned a set of colors, an icon (optional) and a font in which certificates from that category are displayed. The category list also acts as a preview of the settings. Categories can be freely defined by the administrator or the power user, see in .

To set or change the icon of a category, select it in the list, and press the Set Icon... button. The standard &kde; icon selection dialog will appear where you can select an existing icon from the &kde; collection, or load a custom one.

To remove an icon again, you need to press the Default Appearance button.

To change the text (&ie; foreground) color of a category, select it in the list, and press the Set Text Color... button. The standard &kde; color selection dialog will appear where you can select an existing color or create a new one.

Changing the background color is done in the same way, just press Set Background Color... instead.

To change the font, you basically have two options:

1. Modify the standard font, used for all list views in &kde;.

2. Use a custom font.

The first option has the advantage that the font will follow whichever style you choose &kde;-wide, whereas the latter gives you full control over the font to use. The choice is yours.

To use the modified standard font, select the category in the list, and check or uncheck the font modifiers Italic, Bold, and/or Strikeout. You can immediately see the effect on the font in the category list.

To use a custom font, press the Set Font... button. The standard &kde; font selection dialog will appear where you can select the new font.

You can still use the font modifiers to change the custom font, just as for modifying the standard font.

To switch back to the standard font, you need to press the Default Appearance button.

#### Configuring DN-Attribute Order

Although &dn;s are hierarchical, the order of the individual components (called relative &dn;s (RDNs), or &dn; attributes) is not defined. The order in which the attributes are shown is thus a matter of personal taste or company policy, which is why it is configurable in &kleopatra;.

This setting does not only apply to &kleopatra;, but to all applications using &kleopatra; Technology. At the time of this writing, these include &kmail;, &kaddressbook;, as well as &kleopatra; itself, of course.

This configuration page basically consists of two lists, one for the known attributes (Available attributes), and one describing the Current attribute order.

Both lists contain entries described by the short from of the attribute (&eg; CN) as well as the spelled-out form (Common Name).

The Available attributes list is always sorted alphabetically, while the Current attribute order list's order reflects the configured &dn; attribute order: the first attribute in the list is also the one displayed first.

Only attributes explicitly listed in the Current attribute order list are displayed at all. The rest is hidden by default.

However, if the placeholder entry _X_ (All others) is in the current list, all unlisted attributes (whether known or not), are inserted at the point of _X_, in their original relative order.

A small example will help to make this more clear:

Given the &dn;

> O=&kde;, C=US, CN=Dave Devel, X-BAR=foo, OU=&kleopatra;, X-FOO=bar,

the default attribute order of CN, L, _X_, OU, O, C will produce the following formatted &dn;:

> CN=Dave Devel, X-BAR=foo, X-FOO=bar, OU=&kleopatra;, O=&kde;, C=US

while CN, L, OU, O, C will produce

> CN=Dave Devel, OU=&kleopatra;, O=&kde;, C=US

To add an attribute to the display order list, select it in the Available attributes list, and press the Add to current attribute order button.

To remove an attribute from the display order list, select it in the Current attribute order list, and press the Remove from current attribute order button.

To move an attribute to the beginning (end), select it in the Current attribute order list, and press the Move to top (Move to bottom) button.

To move an attribute up (down) one slot only, select it in the Current attribute order list, and press the Move one up (Move one down) button.

### Configuring Crypto Operations

#### Configuring EMail Operations

Here you can configure some aspects of the email operations of &kleopatra;'s &uiserver;. Currently, you can only configure whether to use Quick Mode for signing and encrypting emails, respectively.

Met Snellemodus geactiveerd, wordt er geen dialoog getoond bij respectievelijk ondertekening (versleuteling) van e-mails, tenzij er een conflict is dat handmatig oplossen vereist.

#### Bestandsbewerkingen instellen

Hier kunt u enkele aspecten van de bestandsbewerkingen van &kleopatra;'s &uiserver; instellen. Op dit moment kunt u alleen het te gebruiken controlesomprogramma voor `CHECKSUM_CREATE_FILES` kiezen.

Gebruik Te gebruiken controlesomprogramma om te kiezen welk van de geconfigureerde controlesomprogramma 's gebruikt zou moeten worden bij het aanmaken van controlsombestanden.

Bij het verifiëren van controlesommen wordt het te gebruiken programma automatisch gevonden, gebaseerd op de gevonden controlesombestanden.

The administrator and power user can completely define which checksum programs to make available to &kleopatra; through so-called Checksum Definitions in the config file. See in for details.

### Aspecten van S/MIME-validatie instellen

Op deze pagina kunt u bepaalde aspecten van de validatie van &smime;-certificaten instellen.

Dit is grotendeels eenvoudig een meer gebruikersvriendelijke versie van dezelfde instellingen die u ook vindt in . Alles wat u hier in kan stelen, kunt u ook daar met uitzindering van , wat specifiek voor &kleopatra; is.

De betekenis van de opties is als volgt:

#### Configuring interval certificate checking

Geldigheid van certificaat elke N uren controleren

  This option enables interval checking of certificate validity. You can also choose the checking interval (in hours). The effect of interval checking is the same as ; there is no provision for interval scheduling of or .

  Validation is performed implicitly whenever significant files in `~/.gnupg` change. This option, just like and , therefore only affects external factors of certificate validity.

#### Validatiemethode instellen

Certificaten met CRL's valideren

  If this option is selected, &smime; certificates are validated using Certificate Revocation Lists (&crl;s).

  See for alternative method of certificate validity checking.

Certificaten online valideren (OCSP)

  If this option is selected, &smime; certificates are validated online using the Online Certificates Status Protocol (&ocsp;).

  When choosing this method, a request is sent to the server of the &ca; more or less each time you send or receive a cryptographic message, thus theoretically allowing the certificate issuing agency to track whom you exchange (&eg;) mails with.

  To use this method, you need to enter the &URL; of the &ocsp; responder into .

  See for a more traditional method of certificate validity checking that does not leak information about whom you exchange messages with.

URL-adres OCSP-dienst

  Voer hier het adres in van de server die de certificaten online valideert (&ocsp;-dienst). Het &URL;-adres begint doorgaans met `http://`.

Handtekening OCSP-dienst

  Hier het certificaat kiezen waarmee de &ocsp;-server zijn antwoorden ondertekend.

Service-URL van certificaten negeren

  Each &smime; certificate usually contains the &URL; of its issuer's &ocsp; responder ( will reveal whether a given certificate contains it).

  Checking this option makes &gpgsm; ignore those &URL;s and only use the one configured above.

  Dit &eg; gebruiken om het gebruik van een organisatie-brede &ocsp; proxy af te dwingen.

#### Validatieopties instellen

Certificaatbeleid niet controleren

  By default, &gpgsm; uses the file `~/.gnupg/policies.txt` to check if a certificate policy is allowed. If this option is selected, policies are not checked.

Nooit een CRL raadplegen

  Als deze optie ingeschakeld is, worden Certificate Revocation Lists nooit gebruikt om &smime;-certificaten te valideren.

Sta toe om het hoofdcertificaat als vertrouwd te markeren

  If this option is checked while a root &ca; certificate is being imported, you will be asked to confirm its fingerprint and to state whether or not you consider this root certificate to be trusted.

  A root certificate needs to be trusted before the certificates it certified become trusted, but lightly allowing trusted root certificates into your certificate store will undermine the security of the system.

  Enabling this functionality in the backend can lead to popups from &pinentry; at inopportune times (&eg; when verifying signatures), and can thus block unattended email processing. For that reason, and because it is desirable to be able to distrust a trusted root certificate again, &kleopatra; allows manual setting of trust using and .

  This setting here does not influence the &kleopatra; function.

Ontbrekende uitgevercertificaten ophalen

  If this option is checked, missing issuer certificates are fetched when necessary (this applies to both validation methods, &crl;s and &ocsp;).

#### Configuring &http; request options

Geen HTTP-verzoeken uitvoeren

  Schakelt het gebruik van &http; voor &smime; geheel uit.

HTTP CRL-distributiepunt van certificaten negeren

  When looking for the location of a &crl;, the to-be-tested certificate usually contains what are known as &crl; Distribution Point (DP) entries, which are &URL;s describing the way to access the &crl;. The first-found DP entry is used.

  With this option, all entries using the &http; scheme are ignored when looking for a suitable DP.

HTTP-proxy van systeem gebruiken

  Wanneer deze optie is geselecteerd zal de &http;-proxy, die rechts wordt getoond, gebruikt worden bij elk &http;-verzoek. (De waarde hiervan komt uit de omgevingsvariabele `http_proxy`).

Deze proxy voor HTTP-verzoeken gebruiken

  If no system proxy is set, or you need to use a different proxy for &gpgsm;, you can enter its location here.

  It will be used for all HTTP requests relating to S/MIME.

  The syntax is `host`:`port`, &eg; `myproxy.nowhere.com:3128`.

#### Configuring &ldap; request options

Geen LDAP-verzoeken uitvoeren

  Schakelt het gebruik van &ldap; voor &smime; geheel uit.

LDAP CRL-distributiepunt van certificaten negeren

  When looking for the location of a &crl;, the to-be-tested certificate usually contains what are known as "&crl; Distribution Point" (DP) entries, which are &URL;s describing the way to access the &crl;. The first found DP entry is used.

  With this option, all entries using the &ldap; scheme are ignored when looking for a suitable DP.

Primaire host voor LDAP-verzoeken

  Entering an &ldap; server here will make all &ldap; requests go to that server first. More precisely, this setting overrides any specified host and port part in an &ldap; &URL; and will also be used if host and port have been omitted from the &URL;.

  Other &ldap; servers will be used only if the connection to the proxy failed. The syntax is `host` or `host`:`port`. If port is omitted, port 389 (standard &ldap; port) is used.

### Configuring the GnuPG System

This part of the dialog is auto-generated from the output of `gpgconf `--list-components`` and, for each component that the above command returns, the output of `gpgconf `--list-options` component`.

The most useful of these options have been duplicated as separate pages in the &kleopatra; config dialog. See and for the two dialog pages which contain selected options from this part of the dialog.

The exact content of this part of the dialog depends on the version of the &gnupg; backend you have installed and, potentially, the platform you run on. Thus, we will only discuss the general layout of the dialog, including the mapping from &gpgconf; option to &kleopatra; &GUI; control.

&gpgconf; returns configuration information for multiple components. Inside each component, individual options are combined into groups.

&kleopatra; displays one tab per component reported by &gpgconf;; groups are headed by a horizontal line displaying the group name as returned from &gpgconf;.

Each &gpgconf; option has a type. Except for certain well-known options which &kleopatra; backs with specialised controls for a better user experience, the mapping between &gpgconf; types and &kleopatra; controls is as follows:

#### Mapping From &gpgconf; Types To &GUI; Controls

&gpgconf; type | Besturing van &kleopatra;
--- | ---
voor lijsten | for non-lists
`geen` | Spinbox (count-semantics) | Keuzevakje
`tekenreeks` | &NA; | Lineedit
`int32` | Lineedit (unformatted) | Draaiveld
`uint32`
`pathname` | &NA; | specialised control
`LDAP-server` | specialised control | &NA;
`key fingerprint` | &NA;
`pub key`
`sec key`
`alias list`

See the &gpgconf; manual for more information about what you can configure here, and how.

## Administrator's Guide

This Administrator's Guide describes ways to customize &kleopatra; that are not accessible via the &GUI;, but only via config files.

It is assumed that the reader is familiar with the technology used for &kde; application configuration, including layout, file system location and cascading of &kde; config files, as well as the KIOSK framework.

### Customization of the Certificate-Creation Wizard

#### Customizing the DN fields

&kleopatra; allows you to customize the fields that the user is allowed to enter in order to create their certificate.

Create a group called `CertificateCreationWizard` in the system-wide `kleopatrarc`. If you want a custom order of attributes or if you only want certain items to appear, create a key called `DNAttributeOrder`. The argument is one or more of `CN,SN,GN,L,T,OU,O,PC,C,SP,DC,BC,EMAIL` If you want to initialize fields with a certain value, write something like Attribute=value. If you want the attribute to be treated as a required one, append an exclamation mark (e.g. `CN!,L,OU,O!,C!,EMAIL!`, which happens to be the default configuration).

Using the KIOSK mode modifier `$e` allows to retrieve the values from environment variables or from an evaluated script or binary. If you want to disallow editing of the respective field in addition, use the modifier `$i`. If you want to disallow the use Insert My Address button, set `ShowSetWhoAmI` to false.

Due to the nature of the &kde; KIOSK framework, using the immutable flag (`$i`) makes it impossible for the user to override the flag. This is intended behavior. `$i` and `$e` can be used with all other config keys in &kde; applications as well.

The following example outlines possible customizations:

    [CertificateCreationWizard]
    ;Disallow to copy personal data from the addressbook, do not allow local override
    ShowSetWhoAmI[$i]=false

    ;sets the user name to $USER
    CN[$e]=$USER

    ;sets the company name to "My Company", disallows editing
    O[$i]=My Company

    ;sets the department name to a value returned by a script
    OU[$ei]=$(lookup_dept_from_ip)

    ; sets country to DE, but allows for changes by the user
    C=DE

#### Restricting the Types of Keys a User is Allowed to Create

&kleopatra; also allows to restrict which type of certificates a user is allowed to create. Note, however, that an easy way around these restrictions is to just create one on the command line.

##### Public Key Algorithms

To restrict the public key algorithm to use, add the config key `PGPKeyType` (and `CMSKeyType`, but only RSA is supported for CMS anyway) to the `CertificateCreationWizard` section of `kleopatrarc`.

The allowed values are `RSA` for RSA keys, `DAS` for DSA (sign-only) keys, and `DSA+ELG` for a DSA (sign-only) key with an Elgamal subkey for encryption.

The default is read from &gpgconf; or else `RSA` if &gpgconf; doesn't provide a default.

##### Public Key Size

To restrict the available keys sizes for a public algorithm, add the config key `<ALG>KeySizes` (where ALG may be `RSA`, `DSA` or `ELG`) to the `CertificateCreationWizard` section of `kleopatrarc`, containing a comma-separated list of keysizes (in bits). A default may be indicated by prefixing the keysize with a hyphen (`-`).

    RSAKeySizes = 1536,-2048,3072

The above would restrict allowed RSA key sizes to 1536, 2048 and 3072, with 2048 the default.

In addition to the sizes themselves, you may also specify labels for each of the sizes. Simply set the config key `ALGKeySizeLabels` to a comma-separated list of labels.

    RSAKeySizeLabels = weak,normal,strong

The above, in connection with the previous example, would print something like the following options for selection:

    weak (1536 bits)
                  normal (2048 bits)
                  strong (3072 bits)

The defaults are as if the following was in effect:

    RSAKeySizes = 1536,-2048,3072,4096
                  RSAKeySizeLabels =
                  DSAKeySizes = -1024,2048
                  DSAKeySizeLabels = v1,v2
                  ELGKeySizes = 1536,-2048,3072,4096

### Creating and Editing Key Categories

&kleopatra; allows the user to configure the visual appearance of keys based on a concept called Key Categories. Key Categories are also used to filter the list of certificates. This section describes how you can edit the available categories and add new ones.

When trying to find the category a key belongs to, &kleopatra; tries to match the key to a sequence of key filters, configured in the `libkleopatrarc`. The first one to match defines the category, based on a concept of specificity, explained further below.

Each key filter is defined in a config group named `Key Filter #n`, where n is a number, starting from `0`.

The only mandatory keys in a `Key Filter #n` group are `Name`, containing the name of the category as displayed in the config dialog, and `id`, which is used as a reference for the filter in other configuration sections (such as `View #n`).

lists all keys that define the display properties of keys belonging to that category (&ie; those keys that can be adjusted in the config dialog), whereas lists all keys that define the criteria the filter matches keys against.

#### Key-Filter Configuration Keys Defining Display Properties

Config Key | Type | Beschrijving
--- | --- | ---
`achtergrondkleur` | kleur | The background color to use. If missing, defaults to whichever background color is defined globally for list views.
`voorgrondkleur` | kleur | The foreground color to use. If missing, defaults to whichever foreground color is defined globally for list views.
`lettertype` | lettertype | The custom font to use. The font will be scaled to the size configured for list views, and any font attributes (see below) will be applied.
`font-bold` | boolean | If set to `true` and `font` is not set, uses the default list view font with bold font style added (if available). Ignored if `font` is also present.
`font-italic` | boolean | Analogous to `font-bold`, but for italic font style instead of bold.
`font-strikeout` | boolean | If `true`, draws a centered line over the font. Applied even if `font` is set.
`pictogram` | tekst | The name of an icon to show in the first column. Not yet implemented.

#### Key-Filter Configuration Keys Defining Filter Criteria

Config Key | Type | If specified, filter matches when...
--- | --- | ---
`is-revoked` | boolean | de sleutel is teruggetrokken.
`match-context` | context Context is an enumeration with the following allowed values: `appearance`, `filtering` and `any`. | the context in which this filter matches.
`is-expired` | boolean | de sleutel is verlopen.
`is-uitgeschakeld` | boolean | the key has been disabled (marked for not using) by the user. Ignored for &smime; keys.
`is-root-certificate` | boolean | the key is a root certificate. Ignored for OpenPGP keys.
`can-encrypt` | boolean | the key can be used for encryption.
`can-sign` | boolean | the key can be used for signing.
`can-certify` | boolean | the key can be used for signing (certifying) other keys.
`can-authenticate` | boolean | the key can be used for authentication (&eg; as an TLS client certificate).
`is-qualified` | boolean | the key can be used to make Qualified Signatures (as defined by the German Digital Signature Law).
`is-cardkey` | boolean | the key material is stored on a smartcard (instead of on the computer).
`has-secret-key` | boolean | the secret key for this key pair is available.
`is-openpgp-key` | boolean | the key is an OpenPGP key (`true`), or an &smime; key (`false`).
`was-validated` | boolean | the key has been validated.

`prefix-ownertrust`

geldigheid Validity is an (ordered) enumeration with the following allowed values: `unknown`, `undefined`, `never`, `marginal`, `full`, `ultimate`. See the &gpg; and &gpgsm; manuals for a detailed explanation.

the key has exactly (prefix = `is`), has anything but (prefix = `is-not`), has at least (prefix = `is-at-least`), or has at most (prefix = `is-at-most`) the ownertrust given as the value of the config key. If more than one `prefix-ownertrust` keys (with different prefix values) are present in a single group, the behavior is undefined.

`prefix-validity` | geldigheid | Analogous to `prefix-ownertrust`, but for key validity instead of ownertrust.

Some of the more interesting criteria, such as `is-revoked` or `is-expired` will only work on validated keys, which is why, by default, only validated keys are checked for revocation and expiration, although you are free to remove these extra checks.

In addition to the config keys listed above, a key filter may also have an `id` and `match-contexts`.

Using the filter's `id`, which defaults to the filter's config group name if not given or empty, you can reference the key filter elsewhere in the configuration, &eg; in &kleopatra;'s View configurations. The `id` is not interpreted by &kleopatra;, so you can use any string you like, as long as it's unique.

The `match-contexts` limits the applicability of the filter. Two contexts are currently defined: The `appearance` context is used when defining coloring and font properties for the views. The `filtering` context is used to selectively include (and exclude) certificate from views. `any` can be used to signify all currently defined contexts, and is the default if `match-contexts` is not given, or otherwise produces no contexts. This ensures that no key filter can end up dead, &ie; with no contexts to apply it in.

The format of the entry is a list of tokens, separated by non-word characters. Each of the tokens is optionally prefixed by an exclamation point (`!`), indicating negation. The tokens act in order on an internal list of contexts, which starts out empty. This is best explained by an example: `any !appearance` is the same as `filtering`, and `appearance !appearance` is producing the empty set, as is `!any`. However, the last two will be internally replaced by `any`, since they produce no contexts at all.

In general, criteria not specified (&ie; the config entry is not set) are not checked for. If a criterion is given, it is checked for and must match for the filter as a whole to match, &ie; the criteria are AND'ed together.

Each filter has an implied specificity that is used to rank all matching filters. The more specific filter wins over less specific ones. If two filters have the same specificity, the one that comes first in the config file wins. A filter's specificity is proportional to the number of criteria it contains.

#### Examples of key filters

To check for all expired, but non-revoked root certificates, you would use a key filter defined as follows:

    [Key Filter #n]
    Name=expired, but not revoked
    was-validated=true
    is-expired=true
    is-revoked=false
    is-root-certificate=true
    ; ( specificity 4 )

To check for all disabled OpenPGP keys (not yet supported by &kleopatra;) with ownertrust of at least marginal, you would use:

    [Key Filter #n]
    Name=disabled OpenPGP keys with marginal or better ownertrust
    is-openpgp=true
    is-disabled=true
    is-at-least-ownertrust=marginal
    ; ( specificity 3 )

### Configuring Archivers for Use with Sign/Encrypt Files

&kleopatra; allows the administrator (and power-user) to configure the list of archivers that are presented in the Sign/Encrypt Files dialog.

Each archiver is defined in `libkleopatrarc` as a separate `Archive Definition #n` group, with the following mandatory keys:

`extensies`

  A comma-separated list of filename extensions that usually indicate this archive format.

`id`

  A unique ID used to identify this archiver internally. If in doubt, use the name of the command.

`Name` (translated)

  The user-visible name of this archiver, as shown in the corresponding drop-down menu of the Sign/Encrypt Files dialog.

`pack-command`

  The actual command to archive files. You can use any command, as long as no shell is required to execute it. The program file is looked up using the `PATH` environment variable, unless you use an absolute file path. Quoting is supported as if a shell was used:

      pack-command="/opt/ZIP v2.32/bin/zip" -r -

Since backslash (`\`) is an escape character in KDE config files, you need to double them when they appear in path names:

    pack-command=C:\\Programs\\GNU\\tar\\gtar.exe ...

However, for the command itself (as opposed to its arguments), you may just use forward slashes (`/`) as path separators on all platforms:

    pack-command=C:/Programs/GNU/tar/gtar.exe ...

This is not supported in arguments, as most Windows programs use the forward slash for options. For example, the following will not work, since `C:/myarchivescript.bat` is an argument to `cmd.exe`, and `/` is not converted to `\` in arguments, only commands:

    pack-command=cmd.exe C:/myarchivescript.bat

This needs, instead, to be written as:

    pack-command=cmd.exe C:\\myarchivescript.bat

#### Input Filename Passing for `pack-command`

There are three ways to pass filenames to the pack command. For each of these, `pack-command` provides a particular syntax:

1. As command-line arguments.

   Example (tar):

       pack-command=tar cf -

   Example (zip):

       pack-command=zip -r - %f

   In this case, filenames are passed on the command line, just like you would when using the command prompt. &kleopatra; does not use a shell to execute the command. Therefore, this is a safe way of passing filenames, but it might run into command line length restrictions on some platforms. A literal `%f`, if present, is replaced by the names of the files to archive. Otherwise, filenames are appended to the command line. Thus, the zip Example above could equivalently be written like this:

       pack-command=zip -r -

2. Via standard-in, separated by newlines: prepend `|`.

   Example (GNU-tar):

       pack-command=|gtar cf - -T-

   Example (ZIP):

       pack-command=|zip -@ -

   In this case, filenames are passed to the archiver on stdin, one per line. This avoids problems on platforms which place a low limit on the number of command line arguments that are allowed, but fails when filenames, in fact, contain newlines.

   &kleopatra; currently only supports LF as a newline separator, not CRLF. This might change in future versions, based on user feedback.

3. Via standard-in, separated by NUL-bytes: prepend `0|`.

   Example (GNU-tar):

       pack-command=0|gtar cf - -T- --null

   This is the same as above, except that NUL bytes are used to separate filenames. Since NUL bytes are forbidden in filenames, this is the most robust way of passing filenames, but not all archivers support it.

### Configuring Checksum Programs for Use with Create/Verify Checksums

&kleopatra; allows the administrator (and power-user) to configure the list of checksum programs that the user can choose from in the config dialog and that &kleopatra; is able to auto-detect when asked to verify a given file's checksum.

To be usable by &kleopatra;, output of checksum programs (both the written checksum file, as well as the output on stdout when verifying checksums) needs to be compatible with GNU `md5sum` and `sha1sum`.

Specifically, the checksum file needs to be line-based with each line having the following format:

    CHECKSUM ' ' ( ' ' | '*' ) FILENAME

where CHECKSUM consists of hex-characters only. If FILENAME contains a newline character, the line must instead read:

    \CHECKSUM ' ' ( ' ' | '*' ) ESCAPED-FILENAME

where ESCAPED-FILENAME is the filename with newlines replaced by `\n`s, and backslashes doubled (`\`↦`\\`).

Similarly, the output of must be of the form

    FILENAME ( ': OK' | ': FAILED' )

separated by newlines. Newlines and other characters are not escaped in the output. Ja, deze programma's zijn niet geschreven met een grafisch frontend in gedachten, zodat het &kleopatra; niet zal lukken om op de juiste manier pathologische bestandsnamen die ": OK" plus nieuwe-regel bevatten, te gebruiken.

Elk programma voor controlesommen is gedefinieerd in `libkleopatrarc` als een aparte `Checksum Definition #n` groep, met de volgende verplichte elementen:

`bestandspatronen`

  Een lijst met reguliere expressies die beschrijven welke bestanden beschouwd zouden moeten worden als controlesombestanden voor dit programma voor controlesommen. De syntaxis is die voor lijsten tekenreeksen in KDE configuratiebestanden.

  Omdat reguliere expressies gewoonlijk backslashes bevatten, moet zorgvuldig omgegaan worden met het juiste gebruik van escapes in het configuratiebestand. Het gebruik van een bewerkingshulpmiddel voor een configuratiebestand wordt aangeraden.

  Het platform definieert of de patronen behandeld worden met of zonder onderscheid tussen hoofd- en kleine letter.
`uitvoerbestand`

  De typische naam van het uitvoerbestand voor dit programma voor controlesommen (zou natuurlijk overeen moeten komen met een van de ). Dit is wat &kleopatra; zal gebruiken als de uitvoerbestandsnaam bij het aanmaken van bestanden met controlesommen van dit type.

`id`

  Een unieke ID gebruikt om dit programma voor controlesommen intern te identificeren. Bij twijfel gebruikt u de naam van het commando.

`Name` (translated)

  De voor de gebruiker zichtbare naam van dit programma voor controlesommen, zoals getoond in het afrolmenu in de configuratiedialoog van &kleopatra;.

`create-command`

  Het actuele commando waarmee controlesombestanden worden aangemaakt. De syntax, beperkingen en opties voor argumentenoverdracht zijn hetzelfde als beschreven voor in .

`verify-command`

  Hetzelfde als , echter voor verificatie van de controlesom.

Hier is een volledig voorbeeld:

    [Checksum Definition #1]
              file-patterns=sha1sum.txt
              output-file=sha1sum.txt
              id=sha1sum-gnu
              Name=sha1sum (GNU)
              Name[de]=sha1sum (GNU)
              ...
              create-command=sha1sum -- %f
              verify-command=sha1sum -c -- %f

## Dankbetuiging en licentie

&kleopatra; copyright 2002 &Steffen.Hansen;, &Matthias.Kalle.Dalheimer; en &Jesper.Pedersen;., copyright 2004 &Daniel.Molkentin;, copyright 2004, 2007, 2008, 2009, 2010 Klarälvdalens Datakonsult AB

Documentatie copyright 2002 &Steffen.Hansen;, copyright 2004 &Daniel.Molkentin;, copyright 2004, 2010 Klarälvdalens Datakonsult AB

### Medewerkers

- &Marc.Mutz; &Marc.Mutz.mail;

- &David.Faure; &David.Faure.mail;

- &Steffen.Hansen; hansen@kde.org

- &Matthias.Kalle.Dalheimer; &Matthias.Kalle.Dalheimer.mail;

- &Jesper.Pedersen; &Jesper.Pedersen.mail;

- &Daniel.Molkentin; &Daniel.Molkentin.mail;

&meld.fouten;&vertaling.freek; &underFDL; &underGPL;

&documentation.index;