Skip to content

[strict provenance] add lints for evil pointer casts #95488

Closed
@Gankra

Description

@Gankra
Contributor

This issue is part of the Strict Provenance Experiment - #95228

We should make it easier for people to detect places where they are using casts instead of the "blessed" strict_provenance APIs.

@eddyb and I prototyped this out here: 93f7f06

The patch needs some cleanups, though. Quoting from elsewhere:


All lints should be made allow by default, meaning they're opt-in.

At least in the bootstrap, the compiler will complain if you allow() a lint in your code that doesn't exist. This potentially just means:

  • We need to keep the experimental lint around forever even when the experiment is over
  • Users can only "safely" invoke it from the command line manually, which is slightly unfortunate for anything like what I did where I used it as a FIXME/WONTFIX marker for the file.

Also due to the "Opaque Function Pointers" / "Harvard Architecture" / "AVR is cursed" issue

// HACK: The intermediate cast as usize is required for AVR
// so that the address space of the source function pointer
// is preserved in the final function pointer.
//
// https://github.com/avr-rust/rust/issues/143
fmt::Pointer::fmt(&(*self as usize as *const ()), f)

I think we want the lint broken up into parts:

  • #[fuzzy_provenance_casts] - int-to-ptr, totally evil
  • #[lossy_provencance_casts] - ptr-to-int, sketchy but valid as long as you actually want .addr() semantics
  • #[oxford_casts] - casts that make harvard architectures sad -- fn<->ptr (name is a joke... unless...)

I can't justify discouraging fn <-> int, absent better ways to talk about fn ptrs properly.

Activity

added
A-lintsArea: Lints (warnings about flaws in source code) such as unused_mut.
A-strict-provenanceArea: Strict provenance for raw pointers
on Mar 30, 2022
jrtc27

jrtc27 commented on Mar 30, 2022

@jrtc27
  • #[oxford_casts] - casts that make harvard architectures sad -- fn<->ptr (name is a joke... unless...)

Von Neumann would be the appropriate name if you wanted to highlight that aspect, though some Harvard architectures can handle them just fine too, depends on whether the data pointer representation is sufficient to also safely round-trip function pointers (though it may refer to something else when interpreted as a data pointer).

beepster4096

beepster4096 commented on Mar 30, 2022

@beepster4096
Contributor

Can't we just make this lint unstable like unsafe_block_in_unsafe_fn used to be?

Gankra

Gankra commented on Mar 30, 2022

@Gankra
ContributorAuthor

Oh yes if there's properly lint stability stuff that would be Good To Use (unless that introduces "have to use nightly" and that is deemed unacceptable).

Gankra

Gankra commented on Mar 30, 2022

@Gankra
ContributorAuthor

Oh also I have no idea what the deal is with "safe transmute" stuff, but if these lints can at all look "into" transmutes and try to catch more Secret Casts that would be Friggin' Rad.

eternaleye

eternaleye commented on Mar 30, 2022

@eternaleye
Contributor
  • #[oxford_casts] - casts that make harvard architectures sad -- fn<->ptr (name is a joke... unless...)

Von Neumann would be the appropriate name if you wanted to highlight that aspect, though some Harvard architectures can handle them just fine too, depends on whether the data pointer representation is sufficient to also safely round-trip function pointers (though it may refer to something else when interpreted as a data pointer).

I proposed this in side channels, with the (joking) explanation that "if you start with just a few, they'll proliferate" :P

jswrenn

jswrenn commented on Mar 31, 2022

@jswrenn
Member

Oh also I have no idea what the deal is with "safe transmute" stuff, but if these lints can at all look "into" transmutes and try to catch more Secret Casts that would be Friggin' Rad.

@Gankra Should be possible! The in-development safe(r) transmute API, which will be a distinct API from mem::transmute, is just going to flatly forbid pointer-to-integer and integer-to-pointer transmutations. It should be possible to use that same machinery to lint existing occurrences of mem::transmute.

Lokathor

Lokathor commented on Mar 31, 2022

@Lokathor
Contributor

Bytemuck also removed the Pod impl for pointers a few versions back <3

scottmcm

scottmcm commented on Apr 2, 2022

@scottmcm
Member

Note that lang and libs both want a lint for ptr-to-int via as (https://rust-lang.zulipchat.com/#narrow/stream/219381-t-libs/topic/Adding.20methods.20as.20more.20specific.20versions.20of.20.60as.60/near/238391074) so if anyone wants to pick that up it should hopefully be uncontroversial.

niluxv

niluxv commented on Apr 2, 2022

@niluxv
Contributor

I would like to give it a try.
@rustbot claim

Manishearth

Manishearth commented on Apr 3, 2022

@Manishearth
Member

@Gankra regarding "lints that don't exist", there's a lint deprecation mechanism that allows you to register names as deprecated (and delete the impl), it's used often in clippy and occasionally in rustc

niluxv

niluxv commented on Apr 8, 2022

@niluxv
Contributor

#95599 contains lints for int-to-ptr and ptr-to-int as casts, and will likely be merged soon. @rustbot release-assignment

The exposing API methods introduced by #95588 might be linted against using clippy's disallowed_methods lint (although it doesn't seem possible yet to specify raw pointer methods).

Regarding transmutes it should be pretty trivial to lint against ptr-to-int and int-to-ptr transmutes, but not when the integers/pointers are hidden inside other structs. That will probably require the full safer transmute stuff.

added 3 commits that reference this issue on Apr 8, 2022

Rollup merge of rust-lang#95599 - niluxv:strict-provenance-lint, r=mi…

c5693d3

Rollup merge of rust-lang#95599 - niluxv:strict-provenance-lint, r=mi…

f54d1e1

Rollup merge of rust-lang#95599 - niluxv:strict-provenance-lint, r=mi…

525438b
RalfJung

RalfJung commented on Sep 14, 2024

@RalfJung
Member

The lints have their own dedicated feature and tracking issue now, so closing in favor of that: #130351.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-lintsArea: Lints (warnings about flaws in source code) such as unused_mut.A-strict-provenanceArea: Strict provenance for raw pointersC-future-incompatibilityCategory: Future-incompatibility lints

    Type

    No type

    Projects

    Status

    Idea

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @eternaleye@RalfJung@jrtc27@Gankra@Manishearth

        Issue actions

          [strict provenance] add lints for evil pointer casts · Issue #95488 · rust-lang/rust