> ## Documentation Index > Fetch the complete documentation index at: https://docs.scanoss.com/llms.txt > Use this file to discover all available pages before exploring further. # Get cryptographic hints for a single component. > Returns hints about cryptographic protocols, libraries, SDKs and frameworks used by the component, providing insights into cryptographic dependencies. See: https://github.com/scanoss/papi/blob/main/protobuf/scanoss/api/cryptography/v2/README.md#componenthintsinrange ## OpenAPI ````yaml /api-reference/cryptography-openapi.json get /v2/cryptography/hints/component openapi: 3.0.0 info: title: SCANOSS Cryptography Service description: >- Cryptography service provides cryptographic intelligence for software components including algorithm detection and encryption analysis. version: '2.0' contact: name: scanoss-cryptography url: https://github.com/scanoss/cryptography email: support@scanoss.com servers: - url: http://api.scanoss.com - url: https://api.scanoss.com security: [] tags: - name: Cryptography paths: /v2/cryptography/hints/component: get: tags: - Cryptography summary: Get cryptographic hints for a single component. description: >- Returns hints about cryptographic protocols, libraries, SDKs and frameworks used by the component, providing insights into cryptographic dependencies. See: https://github.com/scanoss/papi/blob/main/protobuf/scanoss/api/cryptography/v2/README.md#componenthintsinrange operationId: Cryptography_GetComponentEncryptionHints parameters: - name: purl description: Package URL identifying the component to analyze. in: query required: true schema: type: string - name: requirement description: >- Version constraint for component resolution when PURL lacks explicit version. in: query required: false schema: type: string responses: '200': description: A successful response. content: application/json: schema: $ref: '#/components/schemas/v2ComponentEncryptionHintsResponse' '404': description: Returned when the resource does not exist. content: application/json: schema: type: string format: string default: description: An unexpected error response. content: application/json: schema: $ref: '#/components/schemas/rpcStatus' components: schemas: v2ComponentEncryptionHintsResponse: type: object example: component: purl: pkg:github/scanoss/engine requirement: '>=5.0.0' version: 5.0.0 hints: - id: openssl-hint-001 name: OpenSSL description: Industry standard cryptographic library category: library url: https://www.openssl.org/ purl: pkg:generic/openssl@3.0.0 status: status: SUCCESS message: Cryptographic hints Successfully retrieved properties: component: $ref: '#/components/schemas/v2ComponentHints' status: $ref: '#/components/schemas/v2StatusResponse' description: >- Response message for ComponentHintsInRange method. Contains cryptographic hint information for a single software component including details about protocols, libraries, SDKs and frameworks used. rpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/protobufAny' v2ComponentHints: type: object properties: purl: type: string description: >- Package URL (PURL) uniquely identifying the component. See Common API Types documentation for format and resolution logic. version: type: string title: Specific version of the component that was analyzed requirement: type: string title: >- Echoes the client's version constraint from the request. See Common API Types documentation for resolution logic hints: type: array items: $ref: '#/components/schemas/v2Hint' title: List of cryptographic hints detected in this component version info_message: type: string description: Status message describing the outcome of processing this component. info_code: type: string description: |- Status code identifying the outcome of processing this component. Possible values: - "INVALID_PURL": The provided Package URL (PURL) is invalid or malformed. - "COMPONENT_NOT_FOUND": The requested component could not be found in the database. - "NO_INFO": No cryptography information is available for the requested component. - "INVALID_SEMVER": The provided semantic version (SemVer) is invalid or malformed. - "VERSION_NOT_FOUND": The specific component version could not be found. description: >- Cryptographic hint information for a specific component identified by PURL and version. Contains comprehensive cryptographic hints about protocols, libraries, SDKs and frameworks used by the component, providing insights into cryptographic dependencies and usage patterns. v2StatusResponse: type: object properties: status: $ref: '#/components/schemas/v2StatusCode' message: type: string title: Status message db: $ref: '#/components/schemas/StatusResponseDB' server: $ref: '#/components/schemas/StatusResponseServer' description: Detailed response details. protobufAny: type: object properties: '@type': type: string description: >- A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading "." is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics. additionalProperties: {} description: >- `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message [google.protobuf.Duration][]): { "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" } v2Hint: type: object properties: id: type: string title: Unique identifier for the cryptographic hint name: type: string title: Name of the cryptographic protocol, library, SDK or framework description: type: string title: >- Brief description of the detected cryptographic usage or implementation category: type: string title: >- Category classification: "protocol", "library", "sdk", or "framework" url: type: string title: Reference URL to project homepage, repository, or documentation purl: type: string title: >- Package URL (PURL) of the original cryptographic library, SDK or framework description: >- Cryptographic hint information. Contains details about cryptographic protocols, libraries, SDKs and frameworks detected in software components, providing insights into cryptographic usage patterns. v2StatusCode: type: string enum: - UNSPECIFIED - SUCCESS - SUCCEEDED_WITH_WARNINGS - WARNING - FAILED default: UNSPECIFIED description: Status code Enum. StatusResponseDB: type: object properties: schema_version: type: string title: Semantic schema version (e.g., 'v1.0.0') created_at: type: string title: When this DB was built (ISO 8601 format) description: Database version information. StatusResponseServer: type: object properties: version: type: string title: Semantic version (e.g., 'v1.0.0') description: Server information. ````