Coder Social home page Coder Social logo

API enhancement about tls-observatory HOT 3 CLOSED

mozilla avatar mozilla commented on July 29, 2024
API enhancement

from tls-observatory.

Comments (3)

jvehent avatar jvehent commented on July 29, 2024

A few endpoints to start with. All endpoints must follow CRUD methodology and return intelligible HTTP error codes.

  • POST /api/v1/scan?target=example.net
    perform a full scan of target https://example.net
  • GET /api/v1/results?target=example.net
    retrieve a JSON document from the database with the results for example.net. If nothing is found, return a 404.
  • GET /api/v1/certificate?target=example.net&raw=false
    returns a JSON of the interpreted certificate of example.net (or a 404). If &raw=true is set, return the raw base64 as plain text (no json).
  • GET /api/v1/search?sha1=abcdef&show=child&limit=100&offset=300
    This would be a more complex search API that would be extended in the future. In the example above, we're listing the children of a root or intermediate cert that has sha1 abcdef, only returning 100 results, and skipping the first 300, for pagination. That type of query would be used by the platform security team to list the certificates impacted by revoking a given intermediate cert, for example via OneCRL. (cc @mozmark).

from tls-observatory.

jvehent avatar jvehent commented on July 29, 2024

On the authentication side: all API calls should require an oauth2 token for now. We can decide to open some endpoints publicly in the future.

from tls-observatory.

jvehent avatar jvehent commented on July 29, 2024

Let's close this for now and create separate issues for specific API endpoints and improvements.

from tls-observatory.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.