Handleiding bij de broncodepreview · 0.1.0

Bevindingen beoordelen en een beslissing vastleggen

Volg een melding vanaf scan en bronbewijs tot een gemotiveerde levenscyclusbeslissing en verifieer gewijzigde code met een nieuwe scan.

De API-referentie is in het Engels.

Begin bij de scan die je wilt beoordelen

Open Findings in de werkbank. Kies project en scan en lees vervolgens bron, dekking, scanstatus en gateoverzicht boven de lijst. Een scan van één bestand beantwoordt een nauwere vraag dan een repositoryscan. Een scan van een vastgelegde Git-boom beschrijft die boom, ook als je huidige werkkopie anders is.

Gebruik het zoekveld en de ernstsnelkeuzes om de lijst te beperken. Vouw filters open als je een scanner of levenscyclusstatus nodig hebt en gebruik Clear filters voor de bredere weergave. Een gefilterde lege lijst betekent niet dat de scan niets vond. Controleer eerst overzicht en actieve filters.

Selecteer een bevindingenrij om de details te openen. Het selectievakje van de rij heeft een andere functie: het voegt de bevinding toe aan een bulkactie. Je kunt een melding inspecteren zonder haar voor wijziging te selecteren.

Lees de melding naast het bewijs

Een bruikbare beoordeling verbindt zes gegevens: bevindingidentificatie, scanner en regel, ernst, bronlocatie, melding en vastgelegd bewijs. Lees ze samen. Bij een regel die een riskante API-aanroep signaleert, moet je mogelijk nog nagaan of onbetrouwbare invoer die aanroep bereikt. Scannerernst beschrijft de melding en vervangt dat onderzoek niet.

Het bewijspaneel begint nabij het relevante bereik. More code, Compact code en Max height bepalen hoeveel vastgelegd bewijs zichtbaar is. Ze halen geen weggelaten repositoryinhoud op. Copy evidence kopieert het vastgelegde gesaneerde bewijs, ook tekst buiten het zichtbare deel; controleer de tekst daarom voordat je haar deelt.

Bevindingdetailpaneel met bronbewijs en beoordelingsacties.

Inspecteer regel, locatie en bewijs voordat je een beslissing vastlegt.

Open de volledige afbeelding

Behandel de voorgestelde reparatie als een voorstel dat je onderzoekt. Het product past haar niet automatisch toe op de broncode. Gebruik desgewenst Advisor voor een tweede lezing van die bevinding en vergelijk het antwoord met bron en scannerregel.

Open de juiste bron in de juiste editor

Gebruik bij een werkruimtebevinding Refresh IDEs, kies de bedoelde gekoppelde IDE en vervolgens Open source in VS Code. Dit helpt wanneer meerdere vensters of profielen zijn verbonden. Een doel kiezen koppelt geen editor en verleent geen brontoegang.

De bronactie controleert bevinding, project, broncontext en doelclient. Een ontbrekend bestand, gewijzigde bron, verkeerde client of niet-ondersteunde context kan navigatie verhinderen. Volg de opgegeven reden in plaats van een gelijknamig bestand te openen en aan te nemen dat het hetzelfde bewijs is.

Een historische bevinding uit een vastgelegde Git-boom kan je huidige werkruimtebestand niet openen alsof het de gescande versie is. Beoordeel het vastgelegde bewijs en de exacte scanidentiteit. Gebruik Git om de commit te inspecteren als meer context nodig is. De VS Code-gids beschrijft de afzonderlijke acties Reveal Finding in Editor en Open Finding in Web.

Onderscheid herhalingsgeschiedenis van meldingen op één locatie

Meerdere scanners kunnen hetzelfde bronbereik melden. Other reports at this location in this view helpt meldingen te vergelijken die voor die exacte locatie zijn geladen. Elke melding behoudt regel, ernst, levenscyclus en gate-effect. De groep beschrijft de geladen weergave, geen volledige zoektocht door alle projecten en scans.

Herhalingsinformatie beantwoordt een andere vraag: of dezelfde scanner en fingerprint eerder in scans van het project voorkwamen. Identieke meldingen binnen één scan kunnen worden gecanonicaliseerd; latere waarnemingen dragen bij aan herhalingsgeschiedenis. Een herhaalde melding bewijst niet dat een nieuwe scan ongewijzigde bron onderzocht.

In VS Code geeft een inlineachtervoegsel +N reports eveneens aan dat de locatie meerdere meldingen heeft. Selecteer via de boom of bevindingenkiezer de melding die je wilt wijzigen.

Kies een levenscyclusstatus met een reden

Open Lifecycle in de bevindingdetails. Kies de status die je beslissing beschrijft en controleer daarna het bijgewerkte gate-effect en scanoverzicht.

Beoordeling en bediening Gewone tellingen Kan de gate blokkeren Reden vereist
Open: Reopen as blocking Ja Ja, volgens beleid Nee
Beoordeling nodig: Needs review Ja Ja, volgens beleid Nee
Niet-blokkerend voor gate: Non-blocking for gate Ja Nee Ja
Risico geaccepteerd: Accept risk Ja Nee Ja
Genegeerd: Ignore / not counted Onderdrukt Nee Ja
Fout-positief: False positive Onderdrukt Nee Ja
Gerepareerd: Mark fixed Onderdrukt Nee Ja

De vijf vrijstellende of onderdrukkende keuzes vereisen een niet-lege reden van maximaal 500 tekens. Geef de volgende beoordelaar voldoende context om de beslissing te begrijpen. Beschrijf bijvoorbeeld de relevante validatie of verwijs naar een interne beslissing met informatie die passend is voor deze installatie. Zet geen inloggegevens of onnodige broncode in de reden.

Lifecycle-bediening voor beoordeling van een bevinding en vastleggen van een reden.

Een status legt een beoordeling vast. Sla gewijzigde bron op en scan opnieuw om de reparatie te verifiëren.

Open de volledige afbeelding

Fixed wijzigt de vastgelegde beoordeling. Het bewijst niet dat de code veranderde of de reparatie werkt. Sla de daadwerkelijke reparatie op en voer een nieuwe scan uit voor nieuw bewijs. Needs review schort blokkering evenmin tijdelijk op. Lees het getoonde gate-effect nadat de actie is afgerond.

Een levenscycluswijziging vult geen gaten in scannerdekking. Een gedeeltelijke, mislukte of geannuleerde scan blijft ongeschikt als volledig geslaagd bewijs, zelfs als alle zichtbare bevindingen zijn vrijgesteld. Een beoordeling kan ook een eerdere goedkeuring voor uitgaande geschiedenis ongeldig maken, omdat die goedkeuring bij de huidige besliscontext moet passen.

Bevindingenbeoordeling / statuskeuzesDiagram
ActieRedenBeoordeling en gate-effect
openOptioneelWis onderdrukking en vrijstelling; neem de bevinding mee in gewone beoordeling en beleidsevaluatie.
needs_reviewOptioneelHoud de bevinding actief voor beoordeling; wis onderdrukking en vrijstelling.
gate_exemptVereistHoud de bevinding zichtbaar en sluit haar uit van blokkerende gatetellingen.
accepted_riskVereistLeg geaccepteerd risico vast; houd de bevinding zichtbaar en stel haar vrij van blokkerende gatetellingen.
ignoreVereistOnderdruk deze bevinding in actieve gatetellingen.
false_positiveVereistLeg de fout-positiefbeslissing vast en onderdruk de bevinding in actieve gatetellingen.
fixedVereistLeg de beoordeling fixed vast en onderdruk de bevinding. Dit verifieert geen broncodewijziging.
Dit zijn expliciete beoordelingsacties, geen lineaire statusladder. Elke wijziging bindt de verwachte bevindingrevisie. Verwijdering staat apart. Een nieuwe scan van opgeslagen bron levert bewijs van codereparatie.

Pas bulkbeslissingen bewust toe

Vink de bedoelde rijen aan en controleer het geselecteerde aantal voordat je bulklevenscyclusacties gebruikt. Selectie kan meerdere geladen pagina’s omvatten. Eén actie accepteert maximaal 200 bevindingen; verklein een grotere selectie in plaats van verborgen opsplitsing te verwachten.

Gebruik dezelfde kwaliteit van reden als bij één bevinding. Een gezamenlijke beslissing helpt als de geselecteerde meldingen dezelfde verklaring hebben. Verschilt hun broncontext, beoordeel ze dan afzonderlijk. Verwijderen is een afzonderlijke bevestigde actie die de geselecteerde bevindingen wegneemt, geen levenscycluslabel dat ze voor later bewaart.

Laat na elke wijziging details en scanoverzicht vernieuwen. Als een andere client de revisie veranderde, open dan de actuele details en neem een nieuwe beslissing. Een oude selectie mag niet stilzwijgend op een nieuwer resultaat worden toegepast.

Inspecteer scanreikwijdte en afgeleide artefacten

Open Scan scope and derived artifacts voor reikwijdte, refs, duur en ondersteunde uitvoer van de gekozen scan. Een ondersteunde SBOM kan Open- of Download-acties bieden. Ruwe scanner-stdout, stderr en native rapporten zijn tijdelijke verwerkingsinvoer, geen algemeen downloadarchief.

Vastgelegd bewijs en artefacten zijn begrensd en gesaneerd met herkende patronen. Controleer hun inhoud voordat je ze deelt. Het bewijspaneel uitbreiden of een SBOM downloaden haalt niet alle bronbestanden van de scan terug.

Begin als API-client met de exacte scan en volg zijn begrensde bevindingenpagina’s. Houd query en revisie gelijk tijdens het volgen van een cursor. Start de leesactie opnieuw als de revisie verandert of een cursor wordt geweigerd, in plaats van oude en nieuwe pagina’s te mengen. De bevindingenoperaties, scanoperaties en artefactoperaties beschrijven deze contracten.

Ga verder met gatebeslissingen als de beoordeling bepaalt of werk kan doorgaan, of met pushbescherming als je de vastgelegde geschiedenis wilt controleren die je gaat verzenden.